Description des codes d'erreur des APIs sparse spatial map
Format de réponse
Toutes les réponses API utilisent un format JSON unifié. Voici un exemple :
{
"statusCode": 119,
"msg": "Parameter has errors",
"date": "2022-06-15T09:56:30.000Z",
"result": //result existe uniquement lorsque statusCode vaut 0 ; en cas d erreur, le champ de resultat est vide
}
| Champ | Type | Description |
|---|---|---|
| statusCode | integer | Code d'état métier. 0 indique le succès, non-0 indique une erreur |
| msg | string | Message |
| result | object | Contenu retourné. Lorsque le status code est 0, répond avec la structure d'objet target image ; sinon vide |
| date | string | Heure du serveur |
Important
result inclut le contenu de réponse uniquement lorsque statusCode == 0. Dans les autres états, result est vide
Lorsque statusCode != 0, faites attention au message d'erreur msg
Catégories de codes d'erreur
Description de HTTP status code
| HTTP status code | Description |
|---|---|
| 200 | Requête réussie (peut contenir des erreurs métier) |
| 400 | Erreur de paramètres de requête |
| 401 | Échec de l'authentification APIKey |
| 403 | Autorisation insuffisante ou accès à la ressource interdit |
| 404 | Le Path de l'API dans l'URL demandée n'existe pas |
| 500 | Erreur interne du serveur |
| 502 | Exception d'application capturée, possible erreur de données |
Remarque : les erreurs métier sont généralement retournées via une réponse HTTP 200, et le type d'erreur précis est identifié dans le champ statusCode.
Tableau des business status code
| Status Code | Message |
|---|---|
| 0 | Success |
| 101 | Uploaded file is empty |
| 102 | File size is too large |
| 106 | Missing parameter or parameter is empty |
| 110 | Call server API errors |
| 111 | Resource not found |
| 401 | Authentication token expired |
| 401 | Authentication parameter is missing |
| 401 | Unknown appId or appKey |
| 401 | Account is locked |
| 401 | Authentication failed, invalid signature or token |
Scénarios d'erreur courants
Timeout sans réponse
- Request Timeout : le réseau est relativement lent. Il est recommandé de vérifier l'environnement réseau du client
Erreurs liées à l'authentification
- Http 401 Unauthorized : échec de l'authentification APIKey. Vérifiez si appId/appKey sont corrects
- Status code 401 : clé d'application invalide ou application inexistante. Vérifiez la configuration de l'application
Erreurs de paramètres
- 400 Bad Request : erreur de format des paramètres de requête
Erreurs d'opération de ressources
- Status code 10x : la ressource target interrogée n'existe pas, ou les paramètres sont incorrects
Erreurs système
- Http 50x Internal Server Error : exception interne du serveur ou exception d'application capturée. Il est recommandé de tester sur le site web ou avec un sample
Recommandations de bonnes pratiques
- Traitement côté client : il est recommandé de déterminer si l'opération métier réussit selon le champ
statusCode, au lieu de s'appuyer uniquement sur HTTP status code - Retry d'erreur : pour les erreurs 5xx, réessayez de manière appropriée ; pour les erreurs 4xx, vérifiez les paramètres de requête
- Journalisation : il est recommandé d'enregistrer la réponse d'erreur complète afin de faciliter le dépannage
- Gestion du timeout : définissez un délai d'attente de requête raisonnable afin d'éviter une attente prolongée