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

Authentification

Authentification

L'API GEOCitation utilise des clés API transmises via l'en-tête X-API-Key.

Créer une Clé API

Rendez-vous sur la page Clés API de votre dashboard. Cliquez sur « Créer une nouvelle clé », donnez-lui un nom, et définissez optionnellement une date d'expiration et une URL webhook pour recevoir les notifications de complétion.

Affichage Unique

Votre clé API et votre secret webhook ne sont affichés qu'une seule fois, à la création. Stockez-les en lieu sûr — ils ne pourront pas être récupérés ultérieurement.

Utiliser la Clé API

Transmettez votre clé dans l'en-tête X-API-Key à chaque requête.

bash
curl -X POST https://api.geocitation.io/v1/audits \
  -H "X-API-Key: geo_citation_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "audit_type": "market", "keyword": "seo agency london", "language": "en", "country": "GB" }'
python
import httpx

response = httpx.post(
    "https://api.geocitation.io/v1/audits",
    headers={"X-API-Key": "geo_citation_YOUR_KEY"},
    json={
        "audit_type": "market",
        "keyword": "seo agency london",
        "language": "en",
        "country": "GB",
    }
)
print(response.json())  # {"audit_id": "...", "status": "pending"}

Révoquer une Clé

Vous pouvez révoquer une clé à tout moment depuis la page Clés API. Les clés révoquées retournent immédiatement un 401.

json
// Response when using a revoked key
HTTP/1.1 401 Unauthorized
{
  "detail": "Invalid or revoked API key"
}
Précédent
Démarrage Rapide
Suivant
Endpoints API