API lýsing · Gjafabréf
Gjafabréf sem PDF
GET/v1/giftcards/{id}/pdf
- Heimild
giftcards:create- Takmarkaflokkur
read- Auðkenning
- Undirrituð
Færibreytur
idstringslóðskylda
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ða | Kóði | Merking |
|---|---|---|
| 400 | invalid_request | Beiðnin er gölluð: ógilt JSON, óþekktur eða ógildur reitur, eða haus vantar. |
| 401 | invalid_signature | MK-* hausana vantar eða þeir eru gallaðir, auðkenni lykilsins er óþekkt eða undirskriftin passar ekki. |
| 401 | key_expired | Gildistími lykilsins er liðinn. |
| 401 | key_revoked | Lykillinn var afturkallaður. |
| 401 | timestamp_out_of_range | MK-Timestamp munar meira en 30 sekúndum frá klukku netþjónsins. |
| 401 | nonce_reused | Þessi lykill hefur þegar notað þetta MK-Nonce. |
| 403 | ip_not_allowed | Beiðnin kom frá IP tölu sem er ekki meðal leyfðra IP talna lykilsins. |
| 403 | insufficient_scope | Lykilinn vantar heimildina sem þessi endapunktur þarf. |
| 403 | account_restricted | Aðgangurinn getur ekki notað API-ið eins og er (til dæmis læstur, óvirkur eða nýskráningu ólokið). |
| 403 | api_access_disabled | Slökkt er á aðgangi að API-inu. |
| 404 | not_found | Þetta fannst ekki. |
| 429 | rate_limited | Of margar beiðnir. Bíddu í Retry-After sekúndur. |
| 429 | too_many_concurrent_requests | Of margar beiðnir í vinnslu í einu fyrir þennan lykil eða aðgang. |
| 429 | key_suspended | Lykillinn er stöðvaður, til dæmis eftir að hafa farið ítrekað yfir beiðnatakmörk. |
| 500 | internal_error | Eitthvað fór úrskeiðis hjá okkur. |
| 502 | bad_gateway | Undirliggjandi þjónusta svaraði á óvæntan hátt. |
| 503 | overloaded | Þjónustan er undir of miklu álagi. Reyndu aftur eftir Retry-After sekúndur. |
| 503 | service_unavailable | Þjónustan er tímabundið ekki tiltæk. |
| 504 | gateway_timeout | Undirliggjandi þ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.pdfimport { 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