Codes d'erreur

Référence des codes HTTP et codes d'erreur métier retournés par l'API Aprovall.

Codes HTTP

L'API utilise les codes HTTP standards pour indiquer le succès ou l'échec d'une requête.

CodeStatutDescription
200OKRequête réussie
400Bad RequestParamètre manquant ou invalide (détail dans la réponse)
401UnauthorizedToken d'authentification invalide ou expiré
403ForbiddenAccès interdit à cette ressource
404Not FoundRessource introuvable
500Server ErrorErreur serveur, réessayez ultérieurement

Codes d'erreur métier

En cas d'erreur 400 ou 500, la réponse contient un code d'erreur métier précisant la cause.

Erreurs générales (E0xx)

CodeDescription
E001Paramètre manquant
E002Paramètre inconnu
E003Paramètre vide
E010Format incorrect
E011Taille maximale dépassée
E021Date d'expiration dans le passé
E022Date dans le futur
E030Domaine email invalide

Erreurs Tiers (E1xx)

CodeDescription
E100Aucune entreprise correspondant à la recherche
E101Erreur lors de la qualification de l'entreprise
E102L'entreprise n'existe pas
E103L'entreprise est fermée
E104Trop d'entreprises pour ces critères
E105L'identifiant de l'entreprise a changé
E111Le code tiers (supplierCode) diffère de l'existant
E112Le code tiers est déjà utilisé par un autre tiers
E113Compte du tiers désactivé
E122Import international impossible (option non activée)

Erreurs Dossier (E2xx)

CodeDescription
E200Aucun dossier correspondant à la recherche
E201Dossier désactivé
E202Cette référence existe déjà pour ce tiers
E203Aucun dossier avec cette référence
E204Dossier déjà actif
E205Réactivation avec une date passée (modifier la date)
E206Type de dossier introuvable
E207Modification des documents interdite sur un dossier typé

Erreurs Document (E3xx)

CodeDescription
E301Document requis désactivé
E302Document requis non autorisé
E303Document désactivé depuis le type de dossier
E304Document non autorisé depuis le type de dossier

Erreurs Dun & Bradstreet (E4xx)

CodeDescription
E401Non autorisé à interroger votre compte D&B
E402Limite de requêtes D&B atteinte

Erreurs Système (E10xx)

CodeDescription
E1000Erreur lors du chiffrement de l'identifiant
E1001Erreur lors du déchiffrement de l'identifiant
E1002SIREN/SIRET requiert countryCode = FR
E1005Valeur invalide
E1006Service temporairement indisponible

Format de la réponse d'erreur

En cas d'erreur, l'API retourne un objet JSON avec le code et le message :

{
  "error": {
    "code": "E201",
    "message": "Dossier disabled"
  }
}

Prochaines étapes