Zum Hauptinhalt springen

Entwickler-API und Webhooks

Erstellen Sie API-Schlüssel, registrieren Sie Webhook-Endpunkte und überprüfen Sie Anfrageprotokolle im Entwicklerzentrum.

Verfasst von Sarah Chen

Das Entwicklerzentrum ist der Ort, an dem Sie Exayard mit Ihrem eigenen Code und Ihren eigenen Werkzeugen verbinden. Öffnen Sie es über Einstellungen und dann Entwickler. Von hier aus erstellen Sie API-Schlüssel, registrieren Webhook-Endpunkte und prüfen ein Live-Protokoll jeder API-Anfrage. Nur Organisationsadministratoren können diese Seite erreichen.

API-Schlüssel

Ein API-Schlüssel authentifiziert Anfragen an die Exayard-API. Schlüssel gehören zu Ihrer Organisation, sodass das richtige Konto automatisch ausgewählt wird und keine Organisations-ID zu übergeben ist.

Öffnen Sie die Registerkarte API-Schlüssel in der Karte Anmeldeinformationen und klicken Sie auf die Schaltfläche +. Geben Sie dem Schlüssel einen Namen und wählen Sie dann seine Berechtigungen. Wählen Sie Alle, um jede Berechtigung zu erteilen, oder Spezifisch, um einzelne Berechtigungen auszuwählen. Berechtigungen folgen je Ressource einer Aufteilung in Lesen und Schreiben, etwa read:projects und write:estimates. Die Berechtigung admin:org ist ein Vollzugriff. Wählen Sie die minimalen Berechtigungen, die Ihre Integration benötigt.

Exayard zeigt den vollständigen Schlüssel einmal an, direkt nachdem Sie ihn erstellt haben. Kopieren Sie ihn dann, denn er wird nie wieder angezeigt. Danach erscheint jeder Schlüssel mit seinem Namen, einer maskierten Vorschau wie ak_••••1234 und dem Datum seiner letzten Verwendung.

Verwenden Sie das Stiftsymbol, um einen Schlüssel umzubenennen oder seine Berechtigungen zu ändern. Verwenden Sie das Papierkorbsymbol, um ihn zu widerrufen. Das Widerrufen ist dauerhaft, und jede Integration, die diesen Schlüssel verwendet, hört sofort auf zu funktionieren.

Derselbe Schlüssel authentifiziert die No-Code-Integrationen. Siehe Exayard mit Zapier verbinden, Exayard mit Make verbinden und Exayard mit n8n verbinden. Für Agenten- und KI-Editor-Zugriff siehe Mit Claude und anderen KI-Tools verbinden.

Webhooks

Ein Webhook weist Exayard an, Ihren Server zu benachrichtigen, wenn etwas geschieht. Öffnen Sie die Registerkarte Webhooks und klicken Sie auf +, um einen Endpunkt hinzuzufügen. Geben Sie die URL ein, die Zustellungen empfangen soll, sowie eine optionale Beschreibung.

Wählen Sie, welche Ereignisse Sie abonnieren möchten. Wählen Sie Alle, um jedes Ereignis zu empfangen, oder Spezifisch, um aus der Liste auszuwählen:

Ereignis

Wird ausgelöst, wenn

project.created

Ein Projekt erstellt wird

project.updated

Ein Projekt geändert wird

project.archived

Ein Projekt archiviert wird

assessment.started

Eine Aufmaßbewertung beginnt

assessment.completed

Eine Bewertung abgeschlossen wird

assessment.approved

Eine Bewertung genehmigt wird

assessment.cancelled

Eine Bewertung abgebrochen wird

estimate.generated

Ein Kostenvoranschlag erstellt wird

bid.generated

Ein Angebot erstellt wird

file.processed

Eine hochgeladene Datei fertig verarbeitet ist

Wenn Sie einen Endpunkt erstellen, zeigt Exayard ein Signaturgeheimnis einmal an. Kopieren Sie es dann, denn es wird nicht wieder angezeigt.

Webhook-Zustellungen absichern

Jede Zustellung trägt einen Header Exayard-Signature in der Form t=<unix>,v1=<digest>. Exayard bildet die Signatur, indem es den Zeitstempel und den Anfragetext zusammenfügt und sie dann mit HMAC-SHA256 unter Verwendung Ihres Endpunktgeheimnisses signiert.

Um eine Zustellung zu verifizieren, berechnen Sie die Signatur mit Ihrem Geheimnis neu, bestätigen Sie, dass der Zeitstempel innerhalb von fünf Minuten von jetzt liegt, und vergleichen Sie die Digests. Fehlgeschlagene Zustellungen werden mit exponentiellem Backoff über etwa drei Tage wiederholt.

Um einen Endpunkt zu bearbeiten, klicken Sie auf das Stiftsymbol. Sie können die URL, die Beschreibung und die Ereignisse ändern und seinen Status auf Aktiv oder Pausiert setzen. Pausierte Endpunkte empfangen keine Zustellungen mehr. Derselbe Dialog hat eine Schaltfläche Geheimnis rotieren. Beim Rotieren wird ein neues Geheimnis ausgestellt, und das alte hört sofort auf zu funktionieren, aktualisieren Sie also Ihren Server, bevor Sie rotieren. Das Papierkorbsymbol löscht einen Endpunkt und beendet alle Zustellungen an ihn.

Schnellstart

Die Karte Schnellstart enthält einen vorgefertigten Prompt für einen KI-Editor wie Claude oder Cursor. Klicken Sie auf Prompt kopieren und fügen Sie ihn in Ihren Editor ein. Der Prompt enthält die API-Basis-URL, das Authentifizierungsformat, das Berechtigungsvokabular und das Webhook-Signaturschema, sodass die KI eine funktionierende Integration aufsetzen und Sie nach den benötigten Details fragen kann.

Dokumentation

Die Karte Dokumentation verlinkt auf die vollständigen Entwicklerdokumente und die OpenAPI-Spezifikation, die jede Route und jedes Schema beschreibt. MCP verbinden öffnet die Einrichtung, um KI-Agenten direkt mit Exayard zu verbinden.

Protokolle

Der Abschnitt Protokolle zeichnet Ihre letzten API-Anfragen über sowohl die REST-API als auch MCP auf. Jede Zeile zeigt die Methode, den Pfad, den Antwortstatus und die Latenz. Wählen Sie eine Zeile, um ihre vollständigen Details zu sehen, einschließlich der Anfrage-ID sowie der Anfrage- und Antworttexte. Verwenden Sie die Protokolle, um zu bestätigen, dass ein Aufruf funktioniert hat, oder um eine fehlschlagende Integration zu debuggen.

Hat dies deine Frage beantwortet?