Ce que vous obtenez
- Des endpoints pour le compte, les sites, le détail d’un site, les contrôles, les réponses IA, l’historique des scores et les changements.
- Les sites peuvent être désignés par leur id ou leur domaine, par ex.
/sites/yourbrand.example. - Pagination avec
next_cursor, 120 requêtes par minute et par clé. - Un contrat versionné : dans la v1, des champs sont seulement ajoutés, jamais supprimés ni renommés.
Avant de commencer
- Un compte OLAB Assist avec l’offre Agency, connecté en tant que propriétaire du compte.
- Un outil capable d’envoyer des requêtes HTTP avec un en-tête (curl, Postman, votre CRM, un script).
Configurer étape par étape
Créer une clé
Intégrations → Clés d’API : donnez-lui le nom de l’outil (par ex. « Synchro HubSpot ») et cliquez sur Créer une clé. Copiez-la tout de suite : elle n’est affichée qu’une seule fois.
Faire votre première requête
Envoyez la clé dans l’en-tête
Authorization. L’exemple ci-dessous liste vos sites avec leurs derniers scores.Choisir les données utiles
Utilisez
/sites/{site}pour une vue complète,/findingspour les problèmes,/answerspour les réponses IA et/historypour l’évolution des scores. La référence complète se trouve dans la documentation développeurs.Le planifier
Lancez votre import une fois par jour ou après chaque webhook
scan.completed, pour ne jamais interroger l’API plus que nécessaire.
curl https://api.olabassist.com/api/v1/sites \
-H "Authorization: Bearer olab_YOUR_KEY"Tips
- Une clé par intégration : la révoquer n’affecte que cet outil.
- Ignorez les champs que vous ne connaissez pas. De nouveaux champs sont ajoutés au fil du temps et votre code continue de fonctionner.
- Pour Google Sheets, un Apps Script avec
UrlFetchAppet un déclencheur quotidien suffit.
Troubleshooting
| Problem | Que faire |
|---|---|
| 401 Unauthorized | La clé est absente, mal saisie ou révoquée. L’en-tête doit être : Authorization: Bearer olab_… |
| 403 API_NOT_IN_PLAN | Le compte n’a pas l’offre Agency (ou un essai est terminé). Passez à l’offre Agency et la même clé fonctionne de nouveau. |
| 429 Too many requests | Vous avez dépassé 120 requêtes par minute. Attendez la durée indiquée par retryAfterSeconds et espacez vos requêtes. |
Questions
L’API peut-elle modifier des données ?
Non. La version 1 est en lecture seule.
Existe-t-il un SDK ?
Pas encore ; l’API repose sur du JSON simple via HTTPS et fonctionne avec n’importe quel langage.
Un membre de l’équipe peut-il créer des clés ?
Non, seul le propriétaire du compte peut créer et révoquer des clés.
Autres intégrations
Les noms de produits et logos appartiennent à leurs propriétaires. OLAB Assist n’est affilié à aucun d’eux.