Des contrats précis. Un sens explicite.
Conventions métier pour montants, identités de requête, idempotence et erreurs. Illustration, pas spécification d’API exécutable.
Répéter la demande, pas l’opération.
Pour les opérations utilisant le service d’idempotence, la clé est limitée à l’organisation et à l’opération. Même clé et même requête canonique rejouent le résultat stocké. Une requête différente avec la même clé crée un conflit. Le client conserve la clé pendant la résolution d’une soumission incertaine.
Idempotency-Key: evaluation-order-0001
// Illustrative header only; no request is sent.
// Current service format: 8–128 characters,
// letters, digits, underscore, period, colon or hyphen.Les erreurs portent une raison et une identité.
Le format d’erreur comprend code, message et requestId. Utilisez cette identité pour discuter d’un échec expurgé avec un contact autorisé. Ne partagez ni identifiants porteurs, ni documents clients, ni réponses fournisseur brutes.
{
"error": {
"code": "capability_disabled",
"message": "This operation is not enabled",
"requestId": "synthetic-request-reference"
}
}| HTTP | Sens métier |
|---|---|
| 400 | Requête invalide. |
| 401 / 403 | Authentification requise / autorité refusée. |
| 404 | Document indisponible dans le périmètre autorisé. |
| 409 | Conflit d’idempotence ou transition invalide. |
| 422 | Contraintes d’actif, environnement, cotation ou capacité. |
| 429 / 503 | Limite de fréquence / fournisseur ou service indisponible. |
Confirmer le contrat exact du point d’accès.
Toutes les routes n’ont pas les mêmes en-têtes, limites ou réponses. Ces conventions expliquent le domaine, pas une garantie de transport universelle. Pagination, reprise, versions et schémas doivent être examinés pour les points d’accès approuvés.