Vai al contenuto

API ecentic: errori.

Ogni errore dell'API di ecentic è un documento problem tipizzato, non una pagina HTML. Il codice è il contratto: è stabile, leggibile da macchina e sicuro da usare nelle diramazioni logiche.

RFC 9457 · Codici stabili · Suggerimenti di risoluzione

01

La struttura di un problema

Un solo media type, un solo schema, su ogni risposta 4xx e 5xx restituita dall'API.

application/problem+json

Le risposte includono Content-Type: application/problem+json — deliberatamente non application/json, perché il media type permette a un client generico di capire che il body descrive un errore e non la risorsa richiesta.

Esempio di risposta

Leggi la risposta

type
L’URI che identifica il problema, ancorato a questo riferimento.
code
L’identificatore stabile su cui il tuo client può basare la logica condizionale.
title
Un breve riepilogo leggibile dalle persone.
status
Lo stato HTTP, ripetuto nel body.
detail
Cosa è andato storto in questa specifica richiesta.
resolution
Il passaggio successivo per risolvere l’errore.
documentation
La pagina di riferimento per la risposta.
instance
Il percorso della richiesta che lo ha generato, quando noto.
02

Catalogo degli errori

I codici vengono congelati una volta pubblicati. Titoli e suggerimenti possono essere riformulati; i codici no.

12Codici problema pubblicati

Apri un codice per leggerne la risoluzione. Ogni codice ha un link permanente.

Link permanente a not-found

Come risolvere

Check the path against the OpenAPI document at /openapi.json or the API catalog at /.well-known/api-catalog.

Link permanente a method-not-allowed

Link permanente a unauthenticated

Link permanente a unauthorized

Link permanente a payment-required

Link permanente a subscription-required

Link permanente a invalid-request

Link permanente a validation-failed

Link permanente a conflict

Link permanente a rate-limited

Link permanente a upstream-timeout

Link permanente a internal-error