Démarrage Rapide
Démarrage Rapide
Effectuez votre premier appel API en 4 étapes.
Étape 1 — Créer une Clé API
Rendez-vous sur la page Clés API de votre dashboard et créez une nouvelle clé. Copiez-la — elle n'est affichée qu'une seule fois. Vous pouvez optionnellement définir une URL webhook dès cette étape pour être notifié à la fin de vos audits.
Essai Gratuit
Étape 2 — Lancer un Audit
Envoyez une requête POST avec votre mot-clé, la langue et le pays. Vous recevrez un 202 avec un audit_id.
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": "agence seo paris",
"language": "fr",
"country": "FR"
}'HTTP/1.1 202 Accepted
{
"audit_id": "3227a3e3-1a2b-4c5d-8e9f-000000000000",
"status": "pending"
}Étape 3 — Récupérer le Résultat
Une fois l'audit terminé, récupérez le payload JSON structuré complet avec une simple requête GET sur le même audit_id.
curl -X GET https://api.geocitation.io/v1/audits/3227a3e3-1a2b-4c5d-8e9f-000000000000 \
-H "X-API-Key: geo_citation_YOUR_KEY"HTTP/1.1 200 OK
{
"audit_id": "3227a3e3-1a2b-4c5d-8e9f-000000000000",
"status": "completed",
"audit_type": "market",
"keyword": "agence seo paris",
"created_at": "2026-07-11T14:32:00Z",
"completed_at": "2026-07-11T14:39:05Z",
"output": { "metadata": { "...": "..." }, "market_serp": { "...": "..." } }
}Étape 4 — Être Notifié (Webhooks)
Si vous avez configuré une URL webhook sur votre clé API, vous recevrez une notification POST dès que votre audit se termine ou échoue — sans avoir à interroger l'API en boucle. Voir la section Webhooks pour les détails.
// Webhook payload received on your endpoint
{
"event": "audit.completed",
"audit_id": "3227a3e3-1a2b-4c5d-8e9f-000000000000",
"status": "completed",
"quality_status": "success",
"total_ms": 305000
}