Villur

Umslagið#

Öll villusvör með JSON meginmáli líta svona út:

{
  "error": {
    "code": "quote_expired",
    "message": "The quote has expired; ask for a new one.",
    "request_id": "req_01JB8X2Q4M7Z3V9K5T1N6R0P2W"
  }
}

• code breytist ekki og er ætlaður forritum. Greindu villur eftir honum.
• message útskýrir villuna fyrir fólki. Textinn getur breyst hvenær sem er, svo ekki þátta hann.
• request_id er líka í MK-Request-Id haus hvers svars, hvort sem beiðnin tókst eða ekki. Skráðu það í annála, og gefðu það upp þegar þú hefur samband við okkur.

2xx staða þýðir að beiðnin tókst; öll önnur svör bera þetta umslag. GET /v1/giftcards/{id}/pdf svarar með application/pdf þegar það tekst og með JSON við villur.

Villukóðar#

Síða hvers endapunkts í API lýsingunni telur upp kóðana sem hann getur skilað.

Að bregðast við villum#

SDK-in breyta hverri villu í ApiError með status, code, message og requestId (request_id í Python), auk retryAfter (retry_after) þegar svarið hafði Retry-After haus. Undirklasar flokka stöðukóðana:

import { ApiError, Myntkaup, RateLimitError } from "@myntkaup/api";

const client = new Myntkaup();

try {
  const trade = await client.buy({ asset: "BTC", quoteAmount: "25.00" });
  console.log(trade.status);
} catch (error) {
  if (error instanceof RateLimitError) {
    console.warn(`Slow down; retry in ${error.retryAfter} s (${error.requestId})`);
  } else if (error instanceof ApiError && ["price_moved", "quote_expired"].includes(error.code)) {
    // The market moved: decide whether to try again with a new quote.
  } else {
    throw error;
  }
}

import myntkaup
from myntkaup import Myntkaup

client = Myntkaup()

try:
    trade = client.buy(asset="BTC", quote_amount="25.00")
    print(trade["status"])
except myntkaup.RateLimitError as error:
    print(f"Slow down; retry in {error.retry_after} s ({error.request_id})")
except myntkaup.ApiError as error:
    if error.code not in ("price_moved", "quote_expired"):
        raise
    # The market moved: decide whether to try again with a new quote.

Hvaða villur á að reyna aftur#

• Reyndu aftur eftir bið: 429 rate_limited, 429 too_many_concurrent_requests, 503 overloaded og 503 service_unavailable (virtu Retry-After), og 502 og 504.
• Reyndu POST beiðni aðeins aftur með sama Idempotency-Key. Eftir 502, 504 eða rofna tengingu gæti beiðnin hafa farið í gegn; sami lykill skilar þá fyrri niðurstöðunni í stað þess að framkvæma beiðnina tvisvar. Sjá síðuna Örugg endurtekning.
• Bíddu, og reyndu svo aftur með sama lykli: 409 idempotency_in_progress.
• Ekki reyna aftur óbreytt: allar aðrar 4xx villur. Breyttu fyrst beiðninni (eða lyklinum, eða verðtilboðinu).
• Reyndu aldrei aftur: 429 key_suspended. Stöðvaðu forritið og lagaðu það.

SDK-in sjá um fyrstu tvö tilvikin fyrir þig: GET beiðni er reynd aftur við 429 (nema key_suspended), 502, 503, 504 og netvillur, og POST beiðni aðeins þegar hún ber Idempotency-Key. Sjálfgefið reyna þau mest tvisvar aftur, með veldisvaxandi bið og slembitöf, og virða Retry-After.