API-dokumentation

Kom i gang

1. Åbn API-nøgler under Konto, og vælg din organisation. Owners og administratorer administrerer nøgler på /konto/virk/<orgslug>/api.
2. Opret en nøgle med de nødvendige scopes og valgte ressourcer eller eksplicit adgang til alle organisationens ressourcer. Hele nøglen vises kun én gang. Opbevar den på din server.
3. Kald GET /api/v1/access for organisationens ID og de ressourcer, nøglen aktuelt kan bruge.
4. Vælg et endpoint i oversigten. Send organisationens og ressourcens ID som query-parametre ved læsning og i JSON-body ved ændringer.

curl 'https://www.tcgm.dk/api/v1/access' \
  --header 'Authorization: Bearer <api-nøgle>'

Scopes og ressourceadgang

Et scope giver lov til en bestemt handling. Ressourceadgangen begrænser, hvilke butikker og netbutikker handlingen må udføres på. Begge krav skal være opfyldt. Organisationen og ressourcen skal være godkendte, aktive og stadig have det korrekte ejerskab.

Adgang til alle ressourcer gælder også fremtidige godkendte ressourcer i samme organisation. Valgt adgang gælder kun de valgte ressourcer. Ingen af delene giver adgang på tværs af organisationer. Organisationens særlige API-scope står på hver operation.

Sikre genforsøg og behandling

Alle ændringer kræver Idempotency-Key og Content-Type: application/json. Brug samme nøgle og samme validerede indhold, når du gentager et kald efter timeout. Brug en ny nøgle til en ny handling. Ændret indhold med en allerede brugt nøgle giver 409.

Ordreoprettelse returnerer 201, mens indholdsopdateringer returnerer 202. Begge giver et eventId, du kan følge via behandlingsstatus. Et accepteret kald betyder ikke, at baggrundsbehandlingen er afsluttet. Direkte køændringer og afslutning returnerer resultatet med det samme.

Fejl og prisvirkninger

400 betyder ugyldigt input, 401 ugyldig nøgle, 403 manglende adgang, 404 manglende ressource og 409 konflikt. Store bodies giver 413, forkert indholdstype 415 og utilgængelig lagring eller behandling 503. Se operationens fejlsvar; direkte handlinger kan også returnere en forretningsfejl med status failed.

Ordreoprettelse registrerer 4 øre, indholds- og køændringer 2 øre og annoncering 4 øre, ekskl. moms. Ordren følger sit låste prisgrundlag og et loft på 25 øre. Identiske genforsøg og allerede matchende direkte tilstande gentager ikke afregningen. API’et foretager ikke betalingsopkrævning.