2GeoCitationDocs
DocsRetour au site
⌘K

Documentation API

v1.0

DOCUMENTATION

Introduction
Concepts Clés
Démarrage Rapide
Authentification

RESSOURCES

Endpoints API
Modèles de Données
Market AuditGap Audit
Webhooks
Erreurs
Glossaire
Cas d'Usage
Limites & Quota
Support

Erreurs

Erreurs

L'API GEOCitation utilise les codes de statut HTTP standards.

CodeSignificationQue faire
202AcceptéAudit en file d'attente. Attendez le webhook ou interrogez /v1/audits/{id}/status.
400Requête invalideVérifiez le corps de la requête — ex. URL non autorisée.
401Non autoriséVotre X-API-Key est manquante, invalide ou révoquée.
402Paiement requisQuota épuisé ou aucun plan actif. Passez à un plan supérieur.
404Non trouvéL'audit_id n'existe pas ou n'appartient pas à votre compte.
409ConflitL'audit n'est pas dans un état permettant cette opération (ex. retry sur un audit déjà terminé).
422Entité non traitableErreur de validation. Vérifiez audit_type, mot clé, pays.
429Trop de requêtesLimite de débit atteinte. Réessayez après Retry-After.
500Erreur serveurErreur serveur inattendue. Réessayez avec backoff exponentiel.
502Passerelle invalideRésultat temporairement malformé. Réessayez la requête.
503Service indisponibleService temporairement indisponible. Réessayez avec backoff.

Limitation de Débit

L'API autorise 100 requêtes par minute globalement et 20 audits par heure et par clé. Dépasser ces limites retourne un 429.

Format des Erreurs

La plupart des erreurs retournent un simple message dans le champ detail. Les erreurs de quota (402) retournent un objet detail structuré avec un contexte additionnel.

json
// Most errors — plain detail message
{
  "detail": "Invalid or revoked API key"
}

// Quota errors — structured detail
{
  "detail": {
    "error": "quota_exceeded",
    "used": 100,
    "limit": 100,
    "plan": "starter"
  }
}
Précédent
Webhooks
Suivant
Glossaire