API

Führen Sie Analysen programmatisch über eine REST-API mit Ihrem Schlüssel aus.

Authentifizierung

Erstellen Sie einen Schlüssel in Ihrem Ihr Konto und senden Sie ihn bei jeder Anfrage im Header X-API-Key. Jede Analyse verbraucht 1 Guthaben von Ihrem Konto oder dem Ihres Teams.

Eine Analyse starten

POST https://serptune.com/api/v1/analyze
X-API-Key: stk_xxxxxxxx.xxxxxxxx
Content-Type: application/json

{
  "url": "https://example.com/your-page",
  "query": "best running shoes",
  "country": "US",
  "language": "en",
  "report_locale": "de"
}

Antwort: { "uuid": "…", "status": "queued", "result_url": "https://serptune.com/api/v1/analysis?id=…" }

Das Ergebnis abrufen

GET https://serptune.com/api/v1/analysis?id=<uuid>
X-API-Key: stk_xxxxxxxx.xxxxxxxx

Fragen Sie alle paar Sekunden ab, bis status auf completed steht. Das Feld report enthält dann das vollständige JSON: Zusammenfassung, priorisierte Maßnahmen sowie die Abschnitte semantische Lücke, UX-Lücke und AI-Reife.

Fehler

401 — ungültiger oder widerrufener API-Schlüssel
402 — zu wenig Guthaben
422 — ungültige Eingabe (url, query, country, language)
429 — zu viele Anfragen, später erneut versuchen

API-Schlüssel erstellen