Integrationsanleitung

Deinen Code mit der Rank Prompt REST-API verbinden

Hol dir KI-Sichtbarkeit in deine eigenen Dashboards und Pipelines oder starte Berichte aus deinem Backend, mit einem Key mit Scopes und einer versionierten /v1-API, dokumentiert in OpenAPI 3.1.

Kostenlos starten Funktion ansehen
REST-API

Rank Prompt liest

  • Deine Anfragen
  • Der Key und seine Scopes

Rank Prompt sendet

  • JSON für Marken, Berichte und Zitate
  • Kontingent-Header
  • Strukturierte Fehler
Rank Prompt

Was es macht

  • Verwaltet Marken, Prompts, Berichte, Zeitpläne, Zitate, Inhalte und SEO-Daten aus deinem Backend.
  • Beschränkt jeden Key auf die Ressourcen, die er braucht, und optional auf eine einzelne Marke.
  • Macht Schreibvorgänge mit einem Idempotency-Key sicher wiederholbar und lässt jeden Aufruf als kostenlose Vorschau mit ?dry_run=true laufen.
  • Veröffentlicht eine maschinenlesbare OpenAPI-3.1-Spezifikation mit einer Referenzseite für jeden Endpunkt.

Bevor du startest

Tarif Jeder Tarif, auch der kostenlose

  • Ein Backend oder Skript, das ein Geheimnis sicher aufbewahren kann. Aufrufe aus dem Browser werden blockiert: Die API läuft von Server zu Server.
  • Einen API-Key aus Entwickler, API-Schlüssel, der beim Erstellen einmal angezeigt wird.
  • Jeder Tarif funktioniert, auch der kostenlose, mit 1.000 Anfragen im Monat im Free-Tarif.
Einrichtung

REST-API: Einrichtung in 4 Schritten

  1. Schritt 1

    Einen Key erstellen

    Öffne in Rank Prompt Entwickler, API-Schlüssel und klicke auf Key erstellen.

    Der Dialog zum Erstellen eines API-Keys: Konto, Name, Scopes, optionale Markenbeschränkung und optionales Ablaufdatum.

  2. Schritt 2

    Scopes, Marke und Ablauf wählen

    Gib ihm einen Namen, den du wiedererkennst, die kleinste Menge an Scopes, die die Integration braucht, eine Marke, wenn er nur eine erreichen soll, und ein Ablaufdatum für Keys, die du an Dienstleister gibst.

  3. Schritt 3

    Den Key sicher speichern

    Der vollständige Key, der mit rp_live_ beginnt, wird einmal angezeigt. Leg ihn in deinen Secret-Manager, nie in Code, der im Browser läuft.

  4. Schritt 4

    Den ersten Aufruf machen

    Ruf GET https://api.rankprompt.com/v1/me mit Authorization: Bearer und deinem Key auf. Die Antwort bestätigt, dass der Key funktioniert und in welchem Konto er handelt.

Fehlerbehebung

REST-API: Fehler und Lösungen

Das sind die Meldungen, die die App zeigt, Wort für Wort, und was jeweils hilft.

  • invalid_api_key: API key is invalid or revoked

    Prüfe, ob der ganze Key kopiert wurde, beginnend mit rp_live_, und ob er unter Entwickler nicht widerrufen wurde.

  • insufficient_scope: API key does not have the required scope

    details.required_scope im Fehler nennt den fehlenden Scope. Erstelle einen Key, der ihn enthält.

  • brand_not_authorized: API key is not authorized for this brand

    Der Key ist auf eine andere Marke beschränkt. Nutze einen Key für diese Marke oder einen ohne Markenbeschränkung.

  • request_quota_exceeded: Monthly request quota exceeded

    Das monatliche Anfragekontingent des Tarifs ist aufgebraucht. Es wird mit dem Abrechnungszeitraum zurückgesetzt; die Kontingent-Header jeder Antwort zeigen, wie viel übrig ist.

  • browser_calls_forbidden: The Public Developer API is server-to-server only. Browser CORS calls are blocked; call /v1 from your backend with a bearer API key.

    Verlege den Aufruf in dein Backend und bewahre den Key dort auf.

Alle Integrationen

FAQ

Häufige Fragen: REST-API

Noch Fragen? Schreib unserem Team

Ist die API in meinem Tarif enthalten?

Ja, in jedem Tarif, auch im kostenlosen. Der Tarif legt das monatliche Anfragekontingent fest, ab 1.000 Anfragen im Free-Tarif, und Aufrufe, die KI-Arbeit erledigen, nutzen die Credits deines Tarifs.

Wo finde ich die API-Referenz?

Unter rankprompt.com/docs/v1, generiert aus derselben OpenAPI-3.1-Spezifikation, die die API ausliefert, mit jedem Endpunkt, Scope, Fehlercode und Credit-Preis.

Kann ein Key nur die Marke eines einzigen Kunden erreichen?

Ja. Beschränke ihn beim Erstellen auf eine Marke, und jede Anfrage für eine andere Marke antwortet mit brand_not_authorized, egal welche Scopes der Key trägt.

Was gilt für Keys, die in einem Teamkonto erstellt wurden?

Ein Key handelt in dem Konto, das beim Erstellen aktiv war. GET /v1/me zeigt account_id, account_role und account_plan, und der Key funktioniert nicht mehr, wenn du dieses Konto verlässt.

In wenigen Minuten startklar

Erstelle ein kostenloses Konto, folge den Schritten oben und sieh, was die Verbindung deiner KI-Sichtbarkeit bringt.

Kostenlos starten Preise ansehen