Spring til indholdet

POS-API · Oversigt

Kassesystem-API

Med API'et kan et kassesystem eller restaurantens eget system hente ordrer, menukort og virksomhedens oplysninger fra WalletPlus — og give kunderne point, når de handler i butikken. Det er REST over HTTPS med JSON ind og ud.

Base-URL

https://api.walletplus.dk/api/pos/v1

Kræver en nøgle, der starter med wp_live_.

Ordrer i næsten realtid

Hent dem med en cursor, eller få dem skubbet til jer med webhooks.

Menukort med varenumre

Hele kortet med ETag, så et uændret kort ikke koster noget at tjekke.

Point ved disken

Slå kundens saldo op, indløs point, og meld butikssalg ind, så kunden optjener.

To ting skal være sande

Adgang kræver både en gyldig API-nøgle og et aktivt samtykke fra den virksomhed, kaldet gælder. Samtykket giver virksomheden inde i WalletPlus, og det kan trækkes tilbage når som helst — så svarer API'et 403 no_grant for netop den virksomhed, mens nøglen virker videre for de andre.

Derfor bærer hvert kald et company_id: i query-strengen ved GET og i bodyen ved POST. En leverandør kan have adgang til hundrede restauranter med samme nøgle; company_id siger, hvilken af dem kaldet gælder.

Kom godt fra start

Kom i gang

Kassesystem-leverandør

  1. 1

    Skriv til os

    Fortæl hvem I er, og hvad integrationen skal kunne, på support@walletplus.dk. Vi opretter jer som partner og aftaler, hvilke adgange I får.
  2. 2

    Få en testnøgle

    En wp_test_-nøgle mod testmiljøet og en demo-restaurant at udvikle imod. Ingen rigtige kunder, ingen risiko.
  3. 3

    Byg

    Mod eksemplerne her og OpenAPI-specifikationen, som I kan generere en klient ud fra.
  4. 4

    Gå live

    Når databehandleraftalen er på plads, udsteder vi live-nøglen. Restauranterne slår jer derefter til under Indstillinger → Kassesystem.

Restaurantens egen udvikler

  1. 1

    Find API-siden

    Log ind i WalletPlus, og gå til Indstillinger → Kassesystem → API til eget system.
  2. 2

    Opret en API-nøgle

    Vælg hvad systemet må, og opret nøglen. Den vises kun én gang, og adgangen gives automatisk.
  3. 3

    Prøv et kald

    Sæt nøglen ind i testværktøjet på samme side, og hent jeres seneste ordrer direkte fra browseren.
  4. 4

    Byg integrationen

    Eksemplerne på API-siden har allerede jeres eget company_id udfyldt.

Første kald

curl -s "https://api.walletplus.dk/api/pos/v1/orders?company_id=3d6f0b52-8a1e-4c7d-9b20-5e4f1a2c3b4d&limit=5" \
  -H "Authorization: Bearer $WALLETPLUS_KEY"

Nøglen står aldrig i eksemplet

Eksemplerne læser nøglen fra miljøvariablen WALLETPLUS_KEY, så den ikke rejser med, når koden kopieres. Erstat company_id med virksomhedens eget id — eksemplet bruger et opdigtet.

Hvad API'et ikke udleverer

Platformens økonomi står ikke i svarene: vores gebyrer og marginer, betalingsudbyderens id'er og udbetalingen til restauranten. Beløbene på en ordre er det, kunden har betalt.

Kundens navn, telefon, e-mail og adresse kræver sin egen adgang, customers:read, så en ren ordre-integration ikke får kundekartoteket forærende. Se Adgang.