Démarrage
L’API Skoup donne un accès programmatique à tout ce que Skoup mesure de vos marques dans les réponses des assistants IA — visibilité, alertes, correctifs, produits, chiffre d’affaires attribué — et permet d’agir depuis vos propres outils. Les webhooks poussent chaque changement important vers vos systèmes au moment où il se produit.
Tout vit sous une seule URL de base :
https://api.skoup.ai/v1L’API suit les principes REST : des URL prévisibles orientées ressources, du JSON en entrée comme en sortie, les verbes et codes HTTP standard, et une authentification Bearer.
Créez une clé API
Dans Skoup, ouvrez Réglages → Développeurs → Clés API et cliquez sur Nouvelle clé. Nommez-la d’après l’intégration qui l’utilisera (par exemple « Looker · dashboards internes »), choisissez ses scopes et, si besoin, limitez-la à certaines marques.
Le secret n’est affiché qu’une seule fois. Copiez-le tout de suite dans votre gestionnaire de secrets : Skoup n’en garde qu’une empreinte et ne pourra plus jamais vous le montrer.
Commencez par une clé de test (skoup_test_…). Elle lit un espace de démonstration et
n’écrit jamais rien : vous construisez votre intégration sans risque. Voir
Mode test.
Listez vos marques
curl https://api.skoup.ai/v1/brands \
-H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"{
"object": "list",
"data": [
{
"id": "br_2xKq8Fh3LmN9pQrT4vWy6Z",
"object": "brand",
"name": "Nordvelo",
"slug": "nordvelo",
"site_url": "https://nordvelo.fr",
"livemode": false
}
],
"has_more": false
}Lisez les mesures d’une marque
Toute ressource propre à une marque vit sous /v1/brands/{brand} :
curl "https://api.skoup.ai/v1/brands/br_2xKq8Fh3LmN9pQrT4vWy6Z/metrics?market=FR&period=90d" \
-H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"Ce sont exactement les chiffres affichés dans l’interface de Skoup : l’API et l’application lisent les mêmes mesures.
Recevez des webhooks
Déclarez un endpoint pour être prévenu quand une alerte s’ouvre, qu’un sampling se termine ou qu’un correctif est vérifié. Rendez-vous sur Webhooks.
Ce que vous pouvez faire
| Domaine | Lecture | Écriture |
|---|---|---|
| Marques et marchés | ✓ | — |
| Mesures de visibilité, requêtes, samplings | ✓ | Ajouter, activer ou désactiver des requêtes |
| Alertes | ✓ | Marquer traitée, ignorer, re-vérifier |
| Tâches (backlog de correctifs) | ✓ | Créer, modifier, faire avancer sur le tableau |
| Produits | ✓ | Créer et modifier les produits manuels |
| Concurrents, readiness, attribution | ✓ | — |
| Events | ✓ | — |
| Endpoints de webhook | ✓ | Créer, supprimer |
La liste complète des endpoints est dans la référence API.
Conventions en bref
- Du JSON partout. Envoyez
Content-Type: application/jsonsur les écritures. - Des identifiants préfixés. Chaque objet a un ID comme
br_…oualrt_…— voir Identifiants. - Les dates sont des chaînes ISO-8601 en UTC (
2026-09-23T08:00:00Z). - Les montants sont une chaîne décimale plus une devise ISO-4217 (
"1899.00","EUR"). - Chaque réponse porte un en-tête
Request-Id. Citez-le si vous contactez le support.