Spring til indholdet

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…
DelEksempelBetydning
wpwpVores mærke, så en lækket nøgle kan genkendes af en kodescanner.
miljølive / testEn testnøgle virker aldrig i produktion, og en live-nøgle aldrig i testmiljøet.
prefix7f3a1b2cDen synlige del. Den står i vores logs — brug den, når I skriver til os om en bestemt nøgle.
hemmelighed43 tegnVises é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.

ScopeGiver adgang tilForklaret
orders:readGET /orders og GET /orders/{id}Se jeres ordrer
menu:readGET /menuSe jeres menukort og priser
company:readGET /companySe åbningstider og stamdata
customers:readKundens navn, telefon, e-mail og leveringsadresse på ordrerneSe kundens navn, telefon og e-mail på ordren
loyalty:readGET /loyalty/balanceSe kundernes pointsaldo
loyalty:writePOST /loyalty/redeemIndløse point ved kassen
sales:writePOST /salesRegistrere 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.