POS-API · Kom godt fra start
Autentificering og adgang
Hvert kald bærer en API-nøgle som bearer-token, og nøglen må kun det, der er givet adgang til. Her er nøglens opbygning, nøgleskifte og de adgange (scopes), API'et kender.
Autentificering
Send nøglen som bearer-token på hvert kald. Der er ingen login-runde og intet token at forny.
Header
Authorization: Bearer wp_live_7f3a1b2c_kK9…| Del | Eksempel | Betydning |
|---|---|---|
wp | wp | Vores mærke, så en lækket nøgle kan genkendes af en kodescanner. |
miljø | live / test | En testnøgle virker aldrig i produktion, og en live-nøgle aldrig i testmiljøet. |
prefix | 7f3a1b2c | Den synlige del. Den står i vores logs — brug den, når I skriver til os om en bestemt nøgle. |
hemmelighed | 43 tegn | Vises én gang, når nøglen oprettes. Vi gemmer kun en hash og kan ikke finde den frem igen. |
Nøgleskifte uden nedetid
I kan have to aktive nøgler ad gangen. Tag den nye i brug, og tilbagekald derefter den gamle: restaurantens egen udvikler gør det under API-nøgler i WalletPlus, en leverandør skriver til os.
Nøglen hører til på en server
Læg den aldrig i en app eller på en hjemmeside, hvor andre kan læse den. Slipper den ud, så tilbagekald den med det samme, eller skriv til os med nøglens prefix — en tilbagekaldt nøgle svarer
401 key_revoked.Adgang
Hvad en nøgle må, er snittet mellem det, der er aftalt for nøglen, og det, restauranten har sagt ja til i WalletPlus. Restauranten kan indsnævre adgangen, men aldrig udvide den. Til restaurantens eget system vælges adgangen under API-nøgler. Mangler en adgang, svarer kaldet 403 missing_scope.
| Scope | Giver adgang til | Forklaret |
|---|---|---|
orders:read | GET /orders og GET /orders/{id} | Se jeres ordrer |
menu:read | GET /menu | Se jeres menukort og priser |
company:read | GET /company | Se åbningstider og stamdata |
customers:read | Kundens navn, telefon, e-mail og leveringsadresse på ordrerne | Se kundens navn, telefon og e-mail på ordren |
loyalty:read | GET /loyalty/balance | Se kundernes pointsaldo |
loyalty:write | POST /loyalty/redeem | Indløse point ved kassen |
sales:write | POST /sales | Registrere butikssalg, så kunden optjener point |
customers:read er sin egen adgang
Uden den får I stadig hele ordren — kundens navn, telefon, e-mail og adresse er bare tomme. Mange integrationer har ikke brug for at vide, hvem der har bestilt.