Aller au contenu

Erreurs

Les erreurs suivent la RFC 9457 (application/problem+json) :

{
"type": "https://developers.lexopti.com/errors/not_found",
"title": "Not Found",
"status": 404,
"code": "not_found",
"detail": "No such client.",
"request_id": "req_4f9c2a7d1e6b4c08a3f5d2e9b7c1a604"
}

Décidez selon code, jamais selon detail. request_id est l’identifiant de la requête, le même que son en-tête Request-Id : journalisez-le, et citez-le quand vous écrivez au support LexOpti à propos d’une requête en échec (identifiants de requête).

Code Statut Signification
validation_failed 400 corps ou paramètres invalides, comme une position d’événements mal formée ou after avec cursor ; errors[] liste les champs, quand l’erreur porte sur des champs
bad_request 400 une requête que LexOpti ne peut pas exécuter telle quelle, comme une analyse à laquelle aucune source ne s’applique ; detail dit pourquoi
incomplete_identity 400 complétez l’identité avant une analyse ; missing[] liste les champs
invalid_cursor 400 curseur d’une autre liste, ou dont la ligne a disparu ; position d’événements au-delà du flux
idempotency_key_required 400 l’opération exige une Idempotency-Key
invalid_idempotency_key 400 l’Idempotency-Key ne fait pas de 1 à 255 caractères ASCII imprimables
invalid_webhook_url 400 l’URL du webhook n’est pas une URL HTTPS où LexOpti peut livrer
invalid_origin 400 l’origine de la session embarquée n’est pas un https://hôte[:port] valide
component_not_available 400 la session embarquée demande un composant que ce déploiement ne sert pas (il les sert tous : client, case, clients, cases, app, new-client et new-case)
invalid_features 400 une fonction demandée par la session embarquée n’appartient pas à son composant
invalid_token 401 jeton absent, invalide ou expiré, ou accès terminé
insufficient_scope 403 le jeton n’a pas la portée de l’opération
readonly_member 403 le membre est en lecture seule
forbidden 403 le membre ne peut pas agir sur cette ressource, comme une alerte d’un client auquel il n’a pas accès
quota_exceeded 403 les crédits ne peuvent pas payer le dossier auquel l’analyse est facturée (il s’ouvre, dépasse ses places ou se renouvelle), ou l’organisation est en lecture seule (ni analyse, ni nouveau client)
subscription_inactive 403 aucune offre ne court : les crédits de l’organisation sont gelés et aucune analyse ne peut être facturée avant un nouvel abonnement
dossier_required 400 le client a plusieurs dossiers ouverts : renvoyez l’un des cases en case_id
embed_not_enabled, origin_not_allowed 403 intégration embarquée non configurée pour cette origine
sandbox_required 403 l’opération ne s’exécute que dans des structures bac à sable : un déclencheur de test, ou une session embarquée d’une application qui n’en ouvre que dans des bacs à sable, comme le client du portail pour l’atelier
installation_required 403 l’opération est réservée à une application qu’un propriétaire ou un administrateur a installée pour toute l’organisation : GET /v1/members (toute une structure)
not_found 404 absent de l’organisation du jeton, ou route inconnue
idempotency_request_in_progress, idempotency_secret_withheld, idempotency_response_unavailable 409 voir requêtes
check_launch_in_progress 409 le premier lancement de l’analyse est encore en cours : réessayez plus tard avec la même clé et le même corps (d’ici là, une nouvelle tentative répond idempotency_request_in_progress)
preliminary_screening_pending 409 une analyse préliminaire du client est déjà en cours : lisez son résultat une fois terminée, ou redemandez alors
external_ref_conflict 409 l’external_ref désigne déjà un autre client ou un autre dossier de votre application : rien n’a été créé ni modifié (vos propres identifiants)
case_closed 409 le dossier est clos, en lecture seule pour de bon : rien ne s’y lance ni ne s’y change
conflict 409 un autre lancement des analyses du même client est en cours : réessayez plus tard
too_many_webhook_endpoints 409 déjà 10 points de réception webhook (activés ou désactivés) pour votre application dans cette organisation : rien n’a été créé ; supprimez-en un dont vous ne vous servez plus (DELETE /v1/webhook-endpoints/{id}, webhooks)
idempotency_key_reused 422 la clé a servi à une autre requête
preliminary_screening_unavailable 503 l’analyse préliminaire n’est pas disponible sur ce déploiement, ou ses listes officielles ne sont pas encore chargées : rien n’a été demandé, réessayez plus tard
rate_limited 429 attendez Retry-After secondes
internal_error 500, 503 réessayez plus tard