Développeurs

API & Webhooks

Récupérez les métriques de visibilité IA de vos restaurants par programme. Authentification par clé API (générée dans Réglages → Data & API). Disponible sur les plans Pro et Enterprise.

Authentification

Passez votre clé dans l’en-tête Authorization.

Authorization: Bearer rr_••••••••••••••••

Lister les restaurants

GET /api/v1/restaurants

curl https://restorank.co/api/v1/restaurants \
  -H "Authorization: Bearer VOTRE_CLÉ"

{
  "count": 1,
  "restaurants": [
    {
      "id": "…",
      "name": "IMA Val d'Isère",
      "city": "Val d'Isère",
      "metrics": {
        "visibility_index": 72,
        "mention_rate": 0.61,
        "average_rank": 2,
        "own_share": 0.38,
        "aggregator_share": 0.62,
        "share_of_voice": 41,
        "by_platform": [ { "platform": "openai", "visibility_index": 78 } ],
        "competitors": [ { "name": "…", "mentions": 9, "beats_you": true } ]
      }
    }
  ]
}

Un restaurant

GET /api/v1/restaurants/:id

curl https://restorank.co/api/v1/restaurants/RESTAURANT_ID \
  -H "Authorization: Bearer VOTRE_CLÉ"

Webhooks

Enregistrez une URL dans Réglages → Data & API. À chaque mesure terminée, on envoie un POST JSON :

POST votre-endpoint
{
  "event": "measurement.completed",
  "restaurant_id": "…",
  "restaurant_name": "IMA Val d'Isère",
  "datapoints": 60,
  "visibility_index": 72,
  "at": "2026-06-05T06:00:00.000Z"
}