Fehler
Jeder Fehlercode, den die PkmnPrices-API zurückgibt, was ihn auslöst und wie eine Fehlerantwort als JSON aussieht.
Die API verwendet die üblichen HTTP-Statuscodes. Jede Fehlerantwort enthält einen JSON-Body mit error.code, error.message und error.docs_url. Letzteres zeigt auf die Seite, die erklärt, was zu tun ist, damit ein Aufrufer einen hilfreichen Link anzeigen kann, ohne ihn fest einzubauen.
| Status | Code | Beschreibung |
|---|---|---|
400 | bad_request | Ungültige Anfrageparameter |
401 | unauthorized | API-Schlüssel fehlt oder ist ungültig |
403 | forbidden | Der API-Schlüssel hat keine Berechtigung für diese Ressource |
404 | not_found | Ressource nicht gefunden |
429 | rate_limited | Zu viele Anfragen, bitte langsamer |
500 | internal_error | Bei uns ist etwas schiefgelaufen |
{"error": {"code": "unauthorized","message": "Missing or invalid API key. Pass a valid key in the X-API-Key header.","docs_url": "https://www.pkmnprices.com/docs#authentication"}}
Ein 429 heißt, dass die Credits des Tages aufgebraucht sind oder das Minutenlimit überschritten wurde. Rate Limits und Credits behandelt beides. Ein 403 betrifft meist Daten, die einem anderen Tarif vorbehalten sind, und keinen falschen Schlüssel; das klärt der Tarifvergleich.
Einen Query-Parameter, den ein Endpoint nicht liest, ignoriert er, statt ihn abzulehnen, und nennt ihn in einem Warning-Header der Antwort, einen pro Parameter, zusammen mit den Parametern, die er akzeptiert. Wirken die Ergebnisse ungefiltert, sieh zuerst in diesen Header: Meist ist ein Filter falsch geschrieben. Einige gängige Alternativen werden als der dokumentierte Name gelesen, etwa limit für per_page, q für name und days für period.