API lýsing · Gjafabréf

Gjafabréf sem PDF

GET/v1/giftcards/{id}/pdf

Takmarkaflokkur
read
Auðkenning
Undirrituð

Færibreytur

  • idstringslóðskylda

    Byrjar á gc_. Dæmi: gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W.

Svör

200 OK

Gjafabréfið til útprentunar. application/pdf

Öll svör bera MK-Request-Id, auk RateLimit-Policy og RateLimit.

Villur

Villur nota villuumslagið. Greindu þær eftir code.

StaðaKóðiMerking
400invalid_requestBeiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar.
401invalid_signatureMK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki.
401key_expiredGildistími lykilsins er liðinn.
401key_revokedLykillinn var afturkallaður.
401timestamp_out_of_rangeMK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins.
401nonce_reusedÞessi lykill hefur þegar notað þetta MK-Nonce.
403ip_not_allowedBeiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins.
403insufficient_scopeLykilinn vantar heimildina sem þessi endapunktur þarf.
403account_restrictedAðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið).
403api_access_disabledSlökkt er á aðgangi að API-inu.
404not_foundÞetta fannst ekki.
429rate_limitedOf margar beiðnir. Bíddu í Retry-After sekúndur.
429too_many_concurrent_requestsOf margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang.
429key_suspendedLykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk.
500internal_errorEitthvað fór úrskeiðis hjá okkur.
502bad_gatewayUndirliggjandi þjónusta svaraði á óvæntan hátt.
503overloadedÞjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur.
503service_unavailableÞjónustan er tímabundið ekki tiltæk.
504gateway_timeoutUndirliggjandi þjónusta svaraði ekki í tæka tíð. POST beiðni gæti samt klárast; reyndu aftur með sama Idempotency-Key.

Beiðni

# Signed by sign-headers.sh: see Authentication
curl https://public-api.myntkaup.is/v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W/pdf \
  $(./sign-headers.sh GET /v1/giftcards/gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W/pdf | sed 's/^/-H /') \
  -o giftcard.pdf
import { writeFile } from "node:fs/promises";
import { Myntkaup } from "@myntkaup/api";

const client = new Myntkaup(); // reads the key from the environment
const pdf = await client.giftcards.pdf("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W"); // Uint8Array
await writeFile("giftcard.pdf", pdf);
from myntkaup import Myntkaup

client = Myntkaup()  # reads the key from the environment
pdf = client.giftcards.pdf("gc_01JB8X2Q4M7Z3V9K5T1N6R0P2W")  # bytes
with open("giftcard.pdf", "wb") as file:
    file.write(pdf)

Svar

application/pdf: skráin sjálf.

Grunnslóð https://public-api.myntkaup.is