Zum Hauptinhalt springen

Zyles Backend-API

Willkommen bei der Referenz für die Zyles-Backend-API — dem Dienst, der die KI-Vertriebsplattform von Zyles antreibt (CRM + Telefonie).

Die API ist ein REST-artiger HTTP-Dienst, der mit actix-web gebaut ist. Alle Anwendungs-Endpunkte liegen unter dem Präfix /api und erwarten JSON-Anfrage- und -Antwort-Bodies.

Basis-URL​

UmgebungBasis-URL
Produktionhttps://backend.zyles.ai

Alle Pfade in dieser Referenz sind relativ zur Basis-URL. Beispielsweise lautet der "Leads hinzufügen"-Endpunkt:

POST https://backend.zyles.ai/api/leads/add

Authentifizierung in einer Zeile​

Jeder Anwendungs-Endpunkt erfordert ein JWT im Authorization-Header:

Authorization: Bearer <your_jwt_token>

Das Token muss einen project_id-Claim enthalten — jeder Datenzugriff ist auf dieses Projekt beschränkt. Weitere Details finden Sie unter Authentifizierung.

Wie diese Referenz aufgebaut ist​

  • Erste Schritte — Authentifizierung, Anfrage-/Antwort-Konventionen und Fehlerbehandlung.
  • API-Referenz — Endpunkte gruppiert nach Ressource (Leads, Jobs, Anrufe, …).
Zur automatisch generierten Swagger-Spezifikation

Das Backend stellt außerdem eine automatisch generierte OpenAPI-Spezifikation unter /swagger-ui/ bereit. Derzeit ist nur eine kleine Anzahl von Endpunkten dort annotiert, sodass sie unvollständig ist — diese handgeschriebene Referenz ist die maßgebliche Referenz. Sobald die Rust-Handler #[utoipa::path]-Annotationen erhalten, wird die Swagger-Spezifikation nachziehen.