Chyby API

Každá chybová odpoveď API nesie pole type s adresou jednej z týchto sekcií. Hlášky v odpovediach sú vždy anglicky - protokol sa nelokalizuje.

Tvar chybovej odpovede

Chyby vraciame podľa RFC 9457 s typom obsahu application/problem+json. Pole type odkazuje na vysvetlenie, title je krátky anglický názov, status opakuje stavový kód HTTP, detail popisuje konkrétny prípad a instance je cesta, na ktorej chyba vznikla.

json

{
  "type": "https://spotforecast.eu/problems/unknown-zone",
  "title": "Unknown bidding zone",
  "status": 404,
  "detail": "Zone XX is not available",
  "instance": "/v1/forecast"
}

`invalid-request`

HTTP 400Invalid request

V požiadavke je parameter, ktorý API neprijíma. Môže chýbať povinný parameter alebo parameter má neznámu hodnotu či zlý formát. Pole detail v odpovedi hovorí, o ktorý parameter ide; jeho povolené hodnoty nájdete pri endpointe v dokumentácii.

`no-route`

HTTP 404No such endpoint

Táto adresa nie je súčasťou API. Skontrolujte cestu vrátane /v1 na začiatku; úplný zoznam endpointov je v openapi.json.

`unknown-zone`

HTTP 404Unknown bidding zone

Takýto kód zóny nepoznáme. Kódy berte z /v1/zones a opisujte ich presne, vrátane veľkých písmen a pomlčiek (DK1, IT-NORD).

`no-forecast`

HTTP 404No forecast for this zone

Zóna existuje, ale vedieme pri nej len zúčtované trhové ceny, žiadnu predpoveď. Použite pre ňu /v1/prices; ktoré zóny predpoveď majú, hovorí pole has_forecast v /v1/zones.

`no-vintage`

HTTP 404No forecast of that vintage

K požadovanému okamihu as_of ani skôr žiadna predpoveď publikovaná nebola. Opakovanie nepomôže - požiadajte o novší as_of.

`missing-credentials`

HTTP 401Missing API key

Požiadavka nenesie API kľúč. Pošlite ho v hlavičke Authorization: Bearer <kľúč> alebo X-API-Key: <kľúč>.

`invalid-credentials`

HTTP 401Invalid API key

Kľúč nepoznáme, alebo bol zrušený. Overte, že ste ho skopírovali celý; nový si vytvoríte vo svojom účte.

`plan-limit`

HTTP 403Not available on your plan

Požiadavka siaha ďalej, než dovoľuje váš plán. Čo váš plán pokrýva, nájdete vo svojom účte.

`rate-limit`

HTTP 429Rate limit exceeded

Denný počet požiadaviek je vyčerpaný. Hlavička Retry-After hovorí, o koľko sekúnd to skúsiť znova, a X-RateLimit-Remaining koľko ich zostáva; limit sa počíta na účet, nie na jednotlivý kľúč, takže viac kľúčov ho nenásobí.

`no-data`

HTTP 503No data available

Pre túto zónu predpovede vydávame, ale zatiaľ nedorazil žiadny beh modelu. Tu sa opakovanie vyplatí - na rozdiel od 404 ide o dočasný stav.

`internal`

HTTP 500Internal server error

Chyba na našej strane. Skúste požiadavku zopakovať, a ak ťažkosť trvá, ozvite sa nám a priložte čas požiadavky a pole instance z odpovede.