Erreurs - The Companies API

The Companies API utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une requête API.

En général, les codes dans la plage 2xx indiquent un succès.

Les codes dans la plage 4xx indiquent une erreur qui a échoué compte tenu des informations fournies (par exemple, un paramètre requis a été omis).

Les codes dans la plage 5xx indiquent une erreur avec nos serveurs (ce sont des cas rares).

Certaines erreurs 4xx qui peuvent être gérées de manière programmable comprennent un code d'erreur qui explique brièvement ce qu'il s'est produit.

Inscrivez-vous pour accéder à toutes les fonctionnalités

Recevez votre jeton d'API et commencez à implémenter l'API dans votre produit avec 500 crédits gratuits.

Aucune carte de crédit requise

Objet d'erreur

error. codestring

Pour certaines erreurs qui peuvent être gérées de manière programmable, un chiffre indiquant le code d'erreur rapporté.

403

error. messagestring

Un message lisible par un humain fournissant plus de détails sur l'erreur.

Missing API token

error. typestring

Le type d'erreur retourné (voir la liste à votre droite).

apiConnectionError

Valeurs possibles

apiConnectionError

apiError

authenticationError

invalidRequestError

noCreditsRemaining

rateLimitError

Résumé des codes de statut HTTP

200 - OKLa requête a réussi.

400 - Bad RequestLa requête est refusée, souvent en raison de l'absence d'un paramètre requis.

401 - UnauthorizedAucun jeton API valide fourni.

402 - Request FailedLes paramètres étaient valides, mais la requête a échoué.

403 - ForbiddenLe jeton API n'a pas la permission d'exécuter la requête.

404 - Not FoundLa ressource demandée n'existe pas.

409 - ConflictLa requête est en conflit avec une autre requête (peut-être en raison de l'utilisation de la même clé idempotente).

429 - Too Many RequestsTrop de requêtes ont frappé l'API trop rapidement. Nous vous recommandons une temporisation de vos requêtes.

500, 502, 503, 504 - Server ErrorsQuelque chose s'est mal passé de notre côté. Ces rares erreurs doivent être signalées, mais nous les enregistrons avec PostHog et les corrigeons dès qu'elles se produisent.

Résumé des types d'erreurs HTTP

apiConnectionErrorÉchec de la connexion à The Companies API.

apiErrorLes erreurs API couvrent tout autre type de problème (par exemple, un problème temporaire avec les serveurs de The Companies API) et sont extrêmement rares.

authenticationErrorÉchec de l'authentification dans la requête.

invalidRequestErrorLes erreurs de requête invalides se produisent lorsque votre requête a des paramètres invalides.

noCreditsRemainingVous n'avez plus de crédits restants pour effectuer cette requête.

rateLimitErrorTrop de requêtes ont frappé l'API trop rapidement. Nous vous recommandons une temporisation de vos requêtes.