Spring til indhold

API

API

Partner-API'et lader dit eget system udstede, slå op og indløse gavekort. Det er almindelig HTTP med JSON — der er ingen SDK, du skal installere.

Base-URL

https://api.pirr.fun

Godkendelse

Alle kald godkendes med en API-nøgle i Authorization-headeren som et bearer-token.

curl https://api.pirr.fun/v1/api/giftcards \
  -H "Authorization: Bearer pk_live_..."

Nøgler oprettes under Indstillinger → API-nøgler. Kun ejeren kan oprette og tilbagekalde dem. Der findes to slags:

PræfiksBruges til
pk_test_Afprøvning. Rører ikke rigtige penge.
pk_live_Drift. Arbejder på rigtige kort og saldi.

Alle kald er bundet til nøglens forretning. Du kan ikke se eller røre en anden forretnings kort, og en nøgle virker kun, mens forretningen er aktiv — en forretning, der endnu ikke har fuldført Stripe, eller som er suspenderet, får 401.

Svarformat

Svar er JSON. Et gavekort ligger under nøglen giftCard, en liste under giftCards.

Fejl

En fejl har altid samme form: et objekt med ét felt kaldet error.

{ "error": "unauthorized" }
StatuserrorBetyder
400invalid_issue_requestKroppen matcher ikke det, udstedelse kræver.
400invalid_redeem_requestKroppen matcher ikke det, indløsning kræver.
400bad_requestKaldet mangler noget grundlæggende, typisk koden i stien.
401unauthorizedNøglen mangler, er tilbagekaldt, eller forretningen er ikke aktiv.
404gift_card_not_foundKoden findes ikke på denne forretning.