Was du bekommst
- Endpunkte für Account, Websites, Website-Details, Ergebnisse, KI-Antworten, Score-Verlauf und Änderungen.
- Websites lassen sich über ID oder Domain ansprechen, z. B.
/sites/yourbrand.example. - Paginierung mit
next_cursor, 120 Anfragen pro Minute und Schlüssel. - Ein versionierter Vertrag: Innerhalb von v1 kommen nur Felder hinzu, keine werden entfernt oder umbenannt.
Bevor du startest
- Ein OLAB Assist-Account im Paket Agency, angemeldet als Account-Inhaber.
- Ein Tool, das HTTP-Anfragen mit Header senden kann (curl, Postman, dein CRM, ein Skript).
Schritt für Schritt einrichten
Schlüssel erstellen
Integrationen → API-Schlüssel: Benenne den Schlüssel nach dem Tool (z. B. „HubSpot-Sync“) und klick auf Schlüssel erstellen. Kopiere ihn sofort; er wird nur einmal angezeigt.
Erste Anfrage senden
Sende den Schlüssel im Header
Authorization. Das Beispiel unten listet deine Websites mit ihren neuesten Scores auf.Benötigte Daten wählen
Nutze
/sites/{site}für das Gesamtbild,/findingsfür Probleme,/answersfür KI-Antworten und/historyfür Scores im Zeitverlauf. Die vollständige Referenz steht in der Entwicklerdokumentation.Einplanen
Führe deinen Import täglich oder nach jedem Webhook
scan.completedaus, damit du nie öfter abfragst als nötig.
curl https://api.olabassist.com/api/v1/sites \
-H "Authorization: Bearer olab_YOUR_KEY"Tips
- Ein Schlüssel pro Integration: Ein Widerruf betrifft nur dieses Tool.
- Ignoriere Felder, die du nicht kennst. Mit der Zeit kommen neue hinzu, und dein Code funktioniert weiter.
- Für Google Sheets genügt ein Apps Script mit
UrlFetchAppund einem täglichen Trigger.
Troubleshooting
| Problem | Was zu tun ist |
|---|---|
| 401 Unauthorized | Der Schlüssel fehlt, ist falsch geschrieben oder wurde widerrufen. Der Header muss lauten: Authorization: Bearer olab_… |
| 403 API_NOT_IN_PLAN | Der Account ist nicht im Paket Agency (oder eine Testversion ist abgelaufen). Nach dem Upgrade funktioniert derselbe Schlüssel wieder. |
| 429 Too many requests | Du hast 120 Anfragen pro Minute überschritten. Warte die Zeit aus retryAfterSeconds ab und verteile die Anfragen. |
Questions
Kann die API Daten ändern?
Nein. Version 1 hat nur Lesezugriff.
Gibt es ein SDK?
Noch nicht; die API ist einfaches JSON über HTTPS und funktioniert mit jeder Programmiersprache.
Kann ein Teammitglied Schlüssel erstellen?
Nein, nur der Account-Inhaber kann Schlüssel erstellen und widerrufen.
Weitere Integrationen
Produktnamen und Logos gehören ihren jeweiligen Inhabern. OLAB Assist ist nicht mit ihnen verbunden.