Zum Inhalt springen
BizQuery

API — Schnellstart

Alles, was Sie in der App tun können, geht auch über eine einfache HTTP-API. Alle Endpunkte liegen unter /v1 und liefern JSON.

1. API-Schlüssel holen

Öffnen Sie in der App Konto → API-Schlüssel und erstellen Sie einen (siehe Teams & Zugriff). Kopieren Sie das Geheimnis sofort — es wird nur einmal angezeigt.

2. Ihre Basis-URL finden

  • Gehostet: https://app.bizquery.dev
  • Selbst gehostet: Ihr eigener BizQuery-Host.

Die API liegt dann unter <basis>/v1.

3. Authentifizieren

Senden Sie den Schlüssel bei jeder Anfrage als Bearer-Token:

Terminal-Fenster
export BQP_BASE="https://app.bizquery.dev"
export BQP_KEY="ihr-api-schlüssel"


curl "$BQP_BASE/v1/personas" \
  -H "Authorization: Bearer $BQP_KEY"

Ein 200 mit einem JSON-Array bedeutet, Sie sind drin. Ein 401 bedeutet, der Schlüssel fehlt oder ist falsch.

Die vollständige Referenz erkunden

Durchstöbern Sie hier die vollständige, interaktive API-Referenz: API-Referenz — jeder Endpunkt mit seinen genauen Anfrage- und Antwortformen, generiert aus der OpenAPI-Spezifikation.

Ihr eigener BizQuery-Host stellt außerdem unter /docs eine live, authentifizierte Swagger-Konsole bereit, um Aufrufe gegen Ihre eigenen Daten auszuprobieren.