Zum Inhalt springen

Für Entwickler

Cyzyra in Ihren Systemen. Und Ihre Systeme innerhalb von Cyzyra.

REST-API, signierte Webhooks und Anbindung an KI-Assistenten. Um Unternehmensdaten in ERP, BI oder Ihre eigene Anwendung zu übertragen.

curl https://YOUR-PAINEL/api/v1/leads?limit=20 \ -H „Autorisierung: Bearer cy_live_…“
{ „data“: [{ „id“: „…“, „name“: „…“, „status“: „new“ }], „next_cursor“: null }

Anschauliches Beispiel für Call and Response.

01 / Drei Wege zur Integration

Lesen, empfangen und fragen.

Verwenden Sie eins, zwei oder alle drei. Sie alle respektieren die Berechtigungen des Schlüssels und der Daten des Unternehmens, dem er gehört.

  • REST-API

    Leads, Verhandlungen, Zahlungen, Objekte und Metriken in JSON, mit OpenAPI-Dokumentation.

  • Webhooks

    18 Unternehmensereignisse werden mit einem Abonnement sofort an Ihr System gesendet.

  • KI-Assistenten (MCP)

    Verbinden Sie Cyzyra mit MCP-kompatiblen KI-Assistenten und fragen Sie nach Umsatz, Werbung und Gewinn.

02 / REST-API

Endpunkte

Authentifizierung durch Autorisierung: Inhaber, JSON-Antworten und Cursor-Paginierung.

  • 120 Anfragen pro Minute und Schlüssel
  • Schlüssel wird nur als Hash gespeichert
  • GET/api/v1/leadsLeads auflisten und suchen
  • POST/api/v1/leadsEinen Lead erstellen (mit Dublettenprüfung)
  • GET/api/v1/leads/{id}Ein Hinweis mit den Details
  • PATCH/api/v1/leads/{id}Aktualisieren Sie einen Lead
  • GET/api/v1/dealsVerhandlungen und Trichterphasen
  • POST/api/v1/dealsErstellen Sie einen Handel
  • GET/api/v1/paymentsAbrechnungen und Zahlungen
  • GET/api/v1/objectsIhre Objekttypen
  • GET/api/v1/objects/{type}/recordsDatensätze eines Objekttyps
  • POST/api/v1/objects/{type}/recordsErstellen Sie einen Datensatz
  • POST/api/v1/queryMetriken mit Filtern und Zeiträumen
  • POST/api/v1/askFrage auf Portugiesisch zu den Daten

03 / Webhooks

Es ist im Unternehmen passiert, es ist in Ihrem System angekommen.

Wählen Sie die Veranstaltungen und die Adresse aus. Jede Einreichung wird signiert und was fehlschlägt, wird bis zu fünf Mal erneut gesendet.

  • HMAC-Signatur mit Zeitangabe, gegen erneutes Versenden
  • Verlauf jedes Versuchs auf dem Dashboard
// Cabeçalho: X-Cyzyra-Signature: t=1731000000,v1=<hmac>
const [t, v1] = header.split(",").map((p) => p.split("=")[1]);
const esperado = hmacSha256(segredo, `${t}.${corpoBruto}`);
if (esperado !== v1) throw new Error("assinatura inválida");

18 verfügbare Veranstaltungen

  • Lead criadolead.created
  • Status do lead mudoulead.status_changed
  • Cadastros unificadoslead.merged
  • Negociação criadadeal.created
  • Negociação mudou de etapadeal.stage_changed
  • Venda ganhadeal.won
  • Venda perdidadeal.lost
  • Vorschlag gesendetproposal.sent
  • Vorschlag angenommenproposal.accepted
  • Proposta recusadaproposal.rejected
  • Vertrag gesendetcontract.sent
  • Contrato assinadocontract.signed
  • Ladung erstelltpayment.created
  • Pagamento recebidopayment.paid
  • Pagamento falhoupayment.failed
  • Pagamento estornadopayment.refunded
  • Ordem de serviço criadawork_order.created
  • Mensagem recebidamessage.received

04 / KI-Assistenten

Fragen Sie Cyzyra aus Ihrem Assistenten.

Fügen Sie die MCP-Adresse von Cyzyra als benutzerdefinierten Connector in einem kompatiblen KI-Assistenten mit Ihrem API-Schlüssel hinzu. Er beginnt mit der Beratung zu Gewinn, Kampagnen und Verkäufen und beantwortet Fragen zu seinen Daten auf Portugiesisch.

URL: https://SEU-PAINEL/api/mcp Header: Autorisierung: Inhaber cy_live_... Tools: summary_profit · Kampagnen · Verkaufsanfragen · manage_campaigns (Schreiben)

05 / Fragen

Technische Fragen

Sehen Sie sich fertige Integrationen an
Wo erstelle ich den API-Schlüssel?+

Im API-Plattform-Dashboard (Menü System → API-Plattform → API-Schlüssel). Der Schlüssel erscheint nur einmal; Cyzyra behält nur eine verschlüsselte Version davon.

Welche Berechtigungen kann ein Schlüssel haben?+

Lesen oder Lesen und Schreiben. Für Aktionen wie das Anlegen von Leads oder das Ändern von Kampagnen über die MCP-Verbindung ist eine Schreibberechtigung erforderlich.

Gibt es eine Nutzungsbeschränkung?+

Ja: 120 Anfragen pro Minute und Schlüssel. Darüber hinaus antwortet die API mit 429 und teilt Ihnen mit, wie viele Sekunden Sie es noch einmal versuchen müssen.

Was passiert, wenn mein System ausfällt, wenn ein Webhook ausgeht?+

Cyzyra versucht es in zunehmenden Abständen bis zu fünf Mal erneut und zeigt jeden Versuch auf dem Dashboard an.

Wessen Daten sieht jeder Schlüssel?+

Nur von der Firma, die den Schlüssel erstellt hat. Daten anderer Unternehmen erscheinen nie.

Erstellen Sie noch heute Ihr Konto und generieren Sie Ihren ersten Schlüssel.

Erster Monat für US$ 10,00, mit vollem Zugriff. Dann wählen Sie den Plan.

Beginnen Sie für US$ 10,00

Möchten Sie lieber mit einer Person sprechen? Sprechen Sie mit dem Team

Bei einer Stornierung fallen keine Strafen an. · Garantie 30 dias

Anschauliches Beispiel, keine realen Daten: Serviceauftrag nach Zahlungseingang geöffnet.
Anschauliches Beispiel