Geoptim API v1

Intégrez Geoptim dans Ihre Tools

Greifen Sie über unsere REST-API direkt auf Projekte, Scores und AI-Analyseergebnisse Ihrer Kunden zu. Integrieren Sie AI-Sichtbarkeit in Ihre Dashboards, Berichte und Workflows.

Anmelden Konto erstellen

API-Dokumentation

Einfache Integration, standardisierte JSON-Antworten

Authentifizierung

Fügen Sie Ihren Token in den Header Authorization jeder Anfrage ein:

# cURL-Beispiel
curl -H "Authorization: Bearer ***token***" \
https://geoptim.ai/api/v1/projects.php
POST GET /api/v1/analyze.php - KI-Analyse starten

POST pour lancer une analyse sur un projet. GET pour suivre son statut.

# Lancer une analyse
POST /api/v1/analyze.php
Body: { "project_id": 42, "question_type": "general" }

# Suivre le statut
GET /api/v1/analyze.php?id=123
project_id * question_type: general|ecommerce|local|saas
GET /api/v1/scores.php - Scores & Metriken

KI-Sichtbarkeitswerte, detaillierte Metriken und Entwicklungsverlauf.

GET /api/v1/scores.php?project_id=42
GET /api/v1/scores.php?project_id=42&last=1
GET /api/v1/scores.php?scan_id=123
project_id Scan-ID last=1 Limit
GET /api/v1/recommendations.php - AI-Empfehlungen

Personalisierte Empfehlungen, die von KI generiert und nach Priorität und Kategorie filterbar sind.

GET /api/v1/recommendations.php?project_id=42
GET /api/v1/recommendations.php?scan_id=123&priority=critical
GET /api/v1/recommendations.php?scan_id=123&category=ai_visibility
project_id Scan-ID priority: critical|high|medium|low category: seo|content|technical|ai_visibility
GET /api/v1/projects.php - Listet alle Ihre Projekte auf

Paramètres optionnels : limit (max 100), offset, status (active/paused/archived)

GET /api/v1/projects.php?limit=10&offset=0
GET /api/v1/projects.php?id=42
GET /api/v1/scans.php - Scans und Ergebnisse

Rufen Sie die Scans eines Projekts ab oder erhalten Sie alle Details eines bestimmten Scans.

GET /api/v1/scans.php?project_id=42
GET /api/v1/scans.php?id=123
GET /api/v1/competitors.php - Wettbewerbsanalyse

Vergleichen Sie Ihre Projekte mit dem globalen Benchmark. Positionierung, Perzentil und Deltas gegenüber dem Durchschnitt.

GET /api/v1/competitors.php
GET /api/v1/competitors.php?project_id=42
Gibt zurück: Scores, globales Benchmark, Perzentil, vs_benchmark, Ihre anderen Projekte
GET POST /api/v1/webhooks.php - Webhooks & Warnungen

Konfigurieren Sie Webhooks, um Echtzeit-Benachrichtigungen zu erhalten (Scan abgeschlossen, Fehler, Punkteänderung).

# Lister les webhooks
GET /api/v1/webhooks.php

# Créer un webhook
POST /api/v1/webhooks.php
Body: { "action": "create", "name": "Mon webhook", "url": "https://...", "events": ["scan.completed"] }

# Tester un webhook
POST /api/v1/webhooks.php
Body: { "action": "test", "webhook_id": 1 }
events: scan.completed | scan.failed | score.change
Signature HMAC-SHA256 dans l'en-tête X-Geoptim-Signature
POST GET /api/v1/reports.php - Automatisierte Berichte

Generieren Sie umfassende Berichte im JSON-Format. Wählen Sie die einzubeziehenden Abschnitte aus: Scores, Empfehlungen, Verlauf, Metriken.

# Générer un rapport
POST /api/v1/reports.php
Body: {
  "project_id": 42,
  "format": "json",
  "include": ["scores", "recommendations", "history", "metrics"]
}

# Récupérer un rapport
GET /api/v1/reports.php?id=5

# Lister mes rapports
GET /api/v1/reports.php?list=1
sections: scores | recommendations | history | metrics | trust
GET /api/v1/stats.php - Globale Statistiken

Synthese-Ansicht: Anzahl der Projekte, Scans, Durchschnittsscore, Top-Projekte und Entwicklung.

GET /api/v1/stats.php

Antwortformat

{
  "success": true,
  "data": { ... },
  "meta": {
    "timestamp": "2026-02-03T12:00:00+01:00",
    "api_version": "v1",
    "usage": {
      "daily_used": 42,
      "daily_limit": 5000,
      "daily_remaining": 4958
    }
  }
}

HTTP-Codes

200
Erfolg
401
Nicht authentifiziert
429
Limit erreicht
404
Ressource nicht gefunden