Zur besseren Verständlichkeit übersetzt. Code, Feldnamen und die API-Referenz bleiben auf Englisch. Englische Fassung

Entwickler

Auf HelpFalcon

Eine REST-API mit OpenAPI-Dokument, eine Zendesk-kompatible API für die Clients, die Sie schon haben, signierte Webhooks, das Messenger-SDK und Seitenleisten-Apps.

API-Referenz Token erstellen

162 REST-Operationen
Zendesk-API unter /zd/api/v2
In jedem bezahlten Plan

Ihre erste Anfrage

curl https://yourcompany.helpfalcon.com/api/tickets?itemsPerPage=5 \
  -H "Authorization: Bearer $HELPFALCON_TOKEN" \
  -H "Accept: application/json"

Basis-URL: die Adresse Ihres Workspaces. REST-API unter /api, Zendesk-kompatible API unter /zd/api/v2.

Schnellstart

1
Token erstellen
Öffnen Sie in Ihrem Workspace Admin Center, Integrations, API tokens und erstellen Sie einen Token mit dem Scope read.
2
API aufrufen
Senden Sie ihn als Bearer-Token, wie in der Anfrage oben. Antworten sind JSON; Sammlungen sind paginiert.
3
Auf Änderungen reagieren
Fügen Sie einen Webhook als Trigger-Aktion hinzu, um signierte Callbacks zu erhalten, wenn sich Tickets ändern.

Die Anfragelimits pro Plan stehen auf der Seite zu Ratenlimits.

Die Plattform entdecken

Authentifizierung API-Tokens mit Lese- oder Schreib-Scope, gesendet als Bearer-Token. REST-API-Referenz 162 Operationen in 39 Ressourcen, generiert aus unserem OpenAPI-Dokument. Zendesk-kompatible API Behalten Sie Ihre Zendesk-API-Clients: nur Basis-URL und Token ändern. Webhooks HMAC-signierte Zustellungen mit Wiederholungen und Zustellprotokoll. Messenger-SDK Messenger einbetten, zE() aufrufen, Besucher per JWT anmelden. Seitenleisten-Apps Apps auf Basis des Zendesk App Framework v2 laufen in der Ticket-Seitenleiste. Kundendaten-Connector Daten aus Ihren eigenen Systemen neben jedem Ticket anzeigen. API-Änderungsprotokoll Was sich an der API geändert hat, das Neueste zuerst. Versionierung und Abkündigung Die API wächst nur, und nichts wird mit weniger als 12 Monaten Vorlauf entfernt. IP-Adressen Die Adressen, von denen unsere Webhooks und Connectors kommen, für Ihre Firewall.

Client-Bibliotheken

Nutzung und Postman-Sammlung

Aus demselben OpenAPI-Dokument generiert wie die Referenz. Sie wiederholen bei Ratenlimits, werfen die Problem-Details der API und blättern für Sie durch Sammlungen.

PHPGenerierter Client

composer require helpfalcon/helpfalcon-php

Nutzungsbeispiel

Node.jsGenerierter Client

npm install @helpfalcon/api

Nutzungsbeispiel

PythonGenerierter Client

pip install helpfalcon

Nutzungsbeispiel

REST-API-Ressourcen

Alle 39 Ressourcen