Chyby API

Každá chybová odpověď API nese pole type s adresou jedné z těchhle sekcí. Hlášky v odpovědích jsou vždy anglicky - protokol se nelokalizuje.

Tvar chybové odpovědi

Chyby vracíme podle RFC 9457 s typem obsahu application/problem+json. Pole type odkazuje na vysvětlení, title je krátký anglický název, status opakuje stavový kód HTTP, detail popisuje konkrétní případ a instance je cesta, na které 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žadavku je parametr, který API nepřijímá. Může chybět povinný parametr nebo parametr má neznámou hodnotu nebo špatný formát. Pole detail v odpovědi říká, o který parametr jde; jeho povolené hodnoty najdete u endpointu v dokumentaci.

`no-route`

HTTP 404No such endpoint

Tahle adresa není součástí API. Zkontrolujte cestu včetně /v1 na začátku; úplný seznam endpointů je v openapi.json.

`unknown-zone`

HTTP 404Unknown bidding zone

Takový kód zóny neznáme. Kódy berte z /v1/zones a opisujte je přesně, včetně velkých písmen a pomlček (DK1, IT-NORD).

`no-forecast`

HTTP 404No forecast for this zone

Zóna existuje, ale vedeme u ní jen zúčtované tržní ceny, žádnou předpověď. Použijte pro ni /v1/prices; které zóny předpověď mají, říká pole has_forecast v /v1/zones.

`no-vintage`

HTTP 404No forecast of that vintage

K požadovanému okamžiku as_of ani dřív žádná předpověď publikovaná nebyla. Opakování nepomůže - požádejte o novější as_of.

`missing-credentials`

HTTP 401Missing API key

Požadavek nenese API klíč. Pošlete ho v hlavičce Authorization: Bearer <klíč> nebo X-API-Key: <klíč>.

`invalid-credentials`

HTTP 401Invalid API key

Klíč neznáme, nebo byl zrušený. Ověřte, že jste ho zkopírovali celý; nový si vytvoříte ve svém účtu.

`plan-limit`

HTTP 403Not available on your plan

Požadavek sahá dál, než dovoluje váš plán. Co váš plán pokrývá, najdete ve svém účtu.

`rate-limit`

HTTP 429Rate limit exceeded

Denní počet požadavků je vyčerpaný. Hlavička Retry-After říká, za kolik sekund to zkusit znovu, a X-RateLimit-Remaining kolik jich zbývá; limit se počítá na účet, ne na jednotlivý klíč, takže víc klíčů ho nenásobí.

`no-data`

HTTP 503No data available

Pro tuhle zónu předpovědi vydáváme, ale zatím nedorazil žádný běh modelu. Tady se opakování vyplatí - na rozdíl od 404 jde o dočasný stav.

`internal`

HTTP 500Internal server error

Chyba na naší straně. Zkuste požadavek zopakovat, a když potíž trvá, ozvěte se nám a přiložte čas požadavku a pole instance z odpovědi.