In den Entwickler-Einstellungen verbinden Sie Exayard mit Ihrem eigenen Code und mit Apps, die andere Unternehmen entwickeln. Öffnen Sie Einstellungen und dann Entwickler. Nur Unternehmensadministratoren sehen diesen Eintrag im Einstellungsmenü. Ein Mitglied, das die Seite öffnet, kann sie lesen, aber nichts ändern.

Apps, API-Schlüssel, Webhooks und Protokolle sind in jedem Tarif enthalten, auch im kostenlosen Tarif. Berechnet wird nur KI-Arbeit.

Eine App ist eine Ihrer Integrationen, zum Beispiel „Acme estimator“ oder „Nightly sync“. Jeder API-Schlüssel gehört zu einer App. Apps ist der erste Bereich auf der Seite. Jedes Mitglied kann ihn lesen. Nur Administratoren erstellen oder ändern Apps.

Klicken Sie auf Neue App und füllen Sie Name, Beschreibung, Website, Support-E-Mail und Berechtigungen aus. Die Berechtigungen sind pro Ressource in Lesen und Schreiben aufgeteilt, zum Beispiel read:projects und write:estimates. Apps können die Berechtigung admin:org nicht anfordern. Ein Unternehmen kann bis zu 25 Apps haben.

Jede App zeigt, wann sie erstellt wurde, und ihr Anfragelimit, zum Beispiel „Bis zu 60 Anfragen pro Minute je Unternehmen und insgesamt 600“. Das Menü Weitere Aktionen der App enthält:

Mit einem API-Schlüssel kann Ihr eigener Code die Exayard-API aufrufen. Schlüssel befinden sich innerhalb einer App unter Schlüssel. Ein Schlüssel funktioniert im eigenen Unternehmen seiner App, daher müssen Sie keine Unternehmens-ID übergeben.

Um einen Schlüssel zu erstellen, klicken Sie in der App auf Neuer Schlüssel. Geben Sie dem Schlüssel unter Name einen Namen, zum Beispiel „Production“. Wählen Sie unter Berechtigungen die Option Alle für sämtliche Berechtigungen der App oder Bestimmte, um weniger auszuwählen. Legen Sie optional ein Datum unter Läuft ab fest, wenn der Schlüssel nur für kurzfristige Arbeit gedacht ist. Der Schlüssel funktioniert bis zum Ende dieses Tages. Klicken Sie auf Erstellen.

Exayard zeigt den vollständigen Schlüssel nur einmal an. Kopieren Sie ihn sofort, denn er wird nie wieder angezeigt. Exayard speichert nur eine verschlüsselte Kopie, daher lässt sich ein verlorener Schlüssel nicht wiederherstellen. Erstellen Sie einen neuen und widerrufen Sie den alten.

Ein Schlüssel beginnt mit exa_live_. Ein in einer Sandbox erstellter Schlüssel beginnt mit exa_test_. Nach dem Erstellen zeigt der Schlüssel seinen Namen, eine Vorschau wie exa_live_...AbCd und Zuletzt verwendet oder Nie verwendet. Ein Schlüssel mit Ablaufdatum zeigt Läuft ab und das Datum, ein abgelaufener Schlüssel zeigt Abgelaufen.

Eine App kann bis zu 25 aktive Schlüssel haben. Ein abgelaufener Schlüssel zählt weiterhin mit, bis Sie ihn widerrufen. Um Schlüssel ohne Unterbrechung zu wechseln, erstellen Sie einen zweiten Schlüssel, stellen Ihre Server darauf um und widerrufen dann den ersten.

Öffnen Sie das Menü Aktionen für Schlüssel, um einen Schlüssel Umzubenennen oder zu Widerrufen. Das Widerrufen kann nicht rückgängig gemacht werden, und der Schlüssel funktioniert innerhalb von 30 Sekunden nicht mehr.

Wenn ein Schlüssel an einem öffentlichen Ort auftaucht, zum Beispiel in einem öffentlichen Code-Repository, widerruft Exayard ihn, benachrichtigt Ihre Administratoren per E-Mail und führt ihn weiterhin in der Liste mit der Kennzeichnung Öffentlich entdeckt, widerrufen.

Wenn ein anderes Unternehmen Ihre App installiert hat, zeigt der Dialog für neue Schlüssel außerdem Gilt für. Dieses Unternehmen ist die Standardeinstellung. Alle Unternehmen, die sie installiert haben erstellt einen Schlüssel, den Ihr Server in jedem dieser Unternehmen verwendet. Jeder Aufruf nennt sein Unternehmen dann im Header Exayard-Organization-Id.

Dieselben Schlüssel verbinden auch die No-Code-Tools. Siehe Exayard mit Zapier verbinden, Exayard mit Make verbinden und Exayard mit n8n verbinden. Für KI-Assistenten siehe Exa mit Ihrem KI-Assistenten verbinden.

Schlüssel, die erstellt wurden, bevor Schlüssel zu Apps gehörten, beginnen mit ak_. Sie funktionieren weiterhin, es können aber keine neuen erstellt werden. Sie erscheinen unten auf der Seite unter Ältere Schlüssel, solange es welche gibt.

Jeder Administrator sieht dort jeden Unternehmensschlüssel, unabhängig davon, wer ihn erstellt hat. Ein Schlüssel, den jemand anderes erstellt hat, zeigt Erstellt von und den Namen der Person. Jede Person sieht außerdem ihre eigenen persönlichen Schlüssel. Klicken Sie auf das Papierkorbsymbol, um einen Schlüssel zu Widerrufen. Er funktioniert sofort nicht mehr.

Eine Sandbox ist ein Testunternehmen, das mit Ihrem Unternehmen verknüpft ist. Damit entwickeln und testen Sie eine Integration, ohne Ihre echten Projekte zu berühren. Nur Administratoren sehen Sandboxes.

Klicken Sie auf Neue Sandbox, geben Sie unter Name einen Namen ein und klicken Sie auf Erstellen. Ein Unternehmen kann bis zu 5 Sandboxes haben. Öffnen wechselt in die Sandbox, und der Unternehmenswechsler kennzeichnet sie mit Sandbox. Erstellen Sie dort wie gewohnt eine App und einen Schlüssel. Ihre Schlüssel beginnen mit exa_test_. Um live zu gehen, erstellen Sie dieselbe App und denselben Schlüssel in Ihrem echten Unternehmen und tauschen den Schlüssel in Ihrem Code aus.

Eine Sandbox folgt dem Tarif Ihres Unternehmens, und Ihr Unternehmen bezahlt ihre Nutzung. Sie hat keine eigene Abrechnung und erhält keine eigene monatliche KI-Nutzung. Webhooks und Integrationen funktionieren wie in Ihrem echten Unternehmen.

Eine Sandbox sendet keine E-Mails zum Teilen von Angeboten und keine signierten Kopien an Personen außerhalb der Sandbox, und sie sendet keine SMS. Diese werden als „Nicht gesendet, da dieses Unternehmen eine Sandbox ist“ angezeigt. Einladungen, der Sandbox beizutreten, werden wie gewohnt gesendet.

Mengenermittlungen und Dateiauswertungen in einer Sandbox liefern kostenlos Ergebnisse, die aus unserem Beispielprojekt kopiert sind. Die Mengenermittlung, ihre Seiten und der Webhook zum Abschluss der Mengenermittlung sind als Beispiele gekennzeichnet. Kalkulationen, Angebote, die Elementsuche und der Chat antworten ebenfalls kostenlos mit Beispielen.

Um eine Sandbox zu entfernen, klicken Sie in ihrer Zeile auf Löschen und dann auf Sandbox löschen. Die Sandbox wird geschlossen, ihre Schlüssel funktionieren nicht mehr, und ihre Daten werden später gelöscht.

Ein Webhook weist Exayard an, Ihren Server zu benachrichtigen, wenn in Ihrem Unternehmen etwas passiert. Jedes Mitglied kann die Liste lesen. Nur Administratoren fügen Webhooks hinzu oder ändern sie.

Klicken Sie auf Webhook erstellen, geben Sie die URL ein, an die Zustellungen gesendet werden sollen, und fügen Sie optional eine Beschreibung hinzu. Wählen Sie, welche Ereignisse gesendet werden sollen. Wählen Sie Alle, um jedes Ereignis zu erhalten, auch neue, oder Bestimmte, um aus der Liste auszuwählen. Alle Ereignisse und ihre Inhalte sind im Webhook-Ereigniskatalog aufgeführt.

Wenn Sie einen Webhook erstellen, zeigt Exayard seinen Signaturschlüssel einmalig an. Kopieren Sie ihn sofort, denn er wird nicht erneut angezeigt.

Das Menü Weitere Aktionen eines Webhooks enthält alles Weitere:

Ein Testereignis und eine erneute Sendung werden einmal gesendet und nie wiederholt.

Jede Zustellung enthält einen Exayard-Signature-Header im Format t=<unix>,v1=<digest>. Exayard bildet die Signatur, indem es den Zeitstempel und den Anfrage-Body verbindet und beides anschließend mit HMAC-SHA256 und dem Schlüssel Ihres Webhooks signiert.

Jede Zustellung enthält außerdem die Header Exayard-Event-Id, Exayard-Event-Type und Exayard-Organization-Id. Der JSON-Body enthält ein Feld organizationId, das das Unternehmen nennt, von dem das Ereignis stammt. Der Header enthält dieselbe ID, sodass Sie eine Zustellung weiterleiten können, bevor Sie den Body lesen. Die Signatur deckt den gesamten Body ab, einschließlich organizationId.

Da jede Zustellung ihr Unternehmen nennt, kann eine einzige Empfängeradresse viele Unternehmen bedienen. Registrieren Sie dieselbe URL in jedem Unternehmen und leiten Sie jede Zustellung anhand von organizationId weiter. Jeder Webhook hat seinen eigenen Schlüssel, wählen Sie den Schlüssel daher vor der Prüfung anhand von Exayard-Organization-Id aus.

Um eine Zustellung zu prüfen, berechnen Sie die Signatur mit Ihrem Schlüssel neu, stellen Sie sicher, dass der Zeitstempel nicht mehr als fünf Minuten von der aktuellen Zeit abweicht, und vergleichen Sie die Digests.

Eine fehlgeschlagene Zustellung wird insgesamt bis zu 10 Mal über etwa 80 Stunden versucht, mit zunehmend längeren Wartezeiten zwischen den Versuchen. Jeder Versuch sendet denselben Body und dieselbe Ereignis-ID. Eine Weiterleitung zählt als Fehlschlag.

Ihre App funktioniert in Ihrem eigenen Unternehmen, sobald Sie sie erstellen. Jede App hat außerdem einen Bereich Anderen Unternehmen die Installation dieser App erlauben. Er zeigt, ob die App Geprüft, Prüfung angefordert oder Nicht geprüft ist, ihre Anmeldeadressen, ihre Client-ID und wie viele Unternehmen sie installieren können.

Administratoren öffnen dafür das Menü Installationsaktionen:

Eine neue App kann zusätzlich zu Ihrem eigenen in bis zu 25 Unternehmen installiert werden und erscheint nicht unter Apps finden. Unternehmen unter Konten für Ihre Kunden zählen nicht zu diesem Limit. Nach der Freigabe zeigt die App Geprüft, und das Installationslimit entfällt. Mit In „Apps finden“ anzeigen listen Sie sie im Verzeichnis jedes Unternehmens auf, mit In „Apps finden“ ausblenden nehmen Sie sie wieder heraus. Eine App mit dem Status Gesperrt kann Exayard nicht aufrufen, bis der Support die Sperre aufhebt. Ihre Installationen bleiben erhalten.

Wenn Sie Berechtigungen aus einer App entfernen, verliert jede Installation sie sofort. Wenn Sie Berechtigungen hinzufügen, behält jedes Unternehmen seinen bisherigen Zugriff, bis einer seiner Administratoren die neuen Berechtigungen genehmigt.

Öffnen Sie das Menü Weitere Aktionen der App und klicken Sie auf Webhook. Geben Sie die URL ein und klicken Sie auf Erstellen. Kopieren Sie dann den Signaturschlüssel, den Exayard nur einmal anzeigt. Jedes Unternehmen, das die App installiert hat, sendet die Ereignisse, die seine gewährten Berechtigungen abdecken. Ihre App erhält außerdem app.installed, app.scopes_approved und app.uninstalled, wenn ein Unternehmen sie installiert, erweiterten Zugriff genehmigt oder sie entfernt. Zustellungen nennen ihr Unternehmen und werden genauso signiert wie andere Webhooks.

Im selben Dialog können Sie Zustellungen Pausieren und Fortsetzen, den Schlüssel erneuern und den Webhook löschen.

Verbundene Apps listet die in Ihrem Unternehmen installierten Apps auf. Jedes Mitglied kann diese Liste sehen. Nur Administratoren installieren, entfernen oder genehmigen.

Jede Zeile zeigt den Namen der App, ob sie Geprüft ist, das Unternehmen, das sie entwickelt hat, wer sie wann installiert hat und welche Berechtigungen ihr gewährt wurden.

Öffnen Sie den Installationslink der App oder klicken Sie unter Apps finden neben der App auf Installieren. Der Dialog zeigt, wer die App entwickelt hat, ob sie geprüft ist und welche Berechtigungen sie anfordert. Wählen Sie dann:

Klicken Sie auf Installieren. Wenn die App Sie anmeldet, leitet Exayard Sie anschließend weiter, damit Sie die Anmeldung bei der App abschließen. Wenn Sie Mitglied, aber kein Administrator sind, zeigt der Dialog an, welcher Administrator welches Unternehmens die App installieren kann. Klicken Sie auf Link kopieren, um ihm den Link zu senden.

Um die Projekte später zu ändern, öffnen Sie den Installationslink erneut und installieren Sie mit der neuen Auswahl.

Wenn eine App weitere Berechtigungen anfordert, zeigt ihre Zeile Fordert mehr Zugriff an mit den neuen Berechtigungen. Ein Administrator klickt auf Genehmigen, um sie zu erteilen. Bis dahin behält die App den bisherigen Zugriff.

Öffnen Sie das Menü Weitere Aktionen der App, klicken Sie auf Entfernen und bestätigen Sie. Die App verliert sofort den Zugriff auf Ihr Unternehmen, und ihre Webhooks werden beendet. KI-Arbeit, die sie bereits gestartet hat, wird noch abgeschlossen.

Apps finden erscheint innerhalb von Verbundene Apps. Hier werden geprüfte Apps aufgelistet, deren Entwickler sich für eine Auflistung entschieden haben. Eine App, die Ihr Unternehmen bereits hat, zeigt Installiert. Klicken Sie bei jeder anderen App auf Installieren, um den Installationsdialog zu öffnen.

Ihre persönlichen Verbindungen listet die KI-Tools und anderen Apps auf, die Sie mit Ihrem eigenen Exayard-Konto verbunden haben, zum Beispiel ChatGPT oder Claude. Die Liste erscheint oben unter Verbundene Apps, und nur Sie sehen Ihre eigenen Verbindungen. Eine persönliche Verbindung handelt in Ihrem Namen und kann daher auf alles zugreifen, worauf auch Sie zugreifen können.

Jede Verbindung zeigt, wann sie zuerst und zuletzt verwendet wurde und in welchen Unternehmen. Um eine Verbindung zu beenden, öffnen Sie ihr Menü Weitere Aktionen, klicken Sie auf Entfernen und bestätigen Sie. Ihr nächster Aufruf wird abgelehnt. Die Verbindung bleibt mit der Kennzeichnung Entfernt in der Liste, und mit Wieder zulassen lassen Sie sie wieder zu. Um ein neues Tool zu verbinden, siehe Exa mit Ihrem KI-Assistenten verbinden.

Ihre App kann über die API Exayard-Unternehmen für Kunden erstellen, die Exayard nur über Ihr Produkt nutzen. Ihr Unternehmen besitzt diese Unternehmen und bezahlt die KI-Arbeit, die in ihnen läuft. Sie haben keine eigenen Mitglieder, und Ihre Apps werden automatisch in ihnen installiert.

Konten für Ihre Kunden listet sie für Administratoren auf, mit Name jedes Unternehmens und dem Datum unter Erstellt. Klicken Sie auf Auflösen und bestätigen Sie, um ein Unternehmen zu schließen. Jede App darin verliert den Zugriff.

Die Karte Schnellstart enthält einen fertigen 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 Basis-URL der API, das Authentifizierungsformat, die Berechtigungen und das Signaturverfahren für Webhooks, sodass die KI eine funktionierende Integration aufsetzen und Sie nach den benötigten Details fragen kann. Nur Administratoren sehen diese Karte, da sie einen API-Schlüssel benötigt.

Die Karte Dokumentation verlinkt mit Dokumentation öffnen auf die vollständige Entwicklerdokumentation sowie auf die OpenAPI-Spezifikation, die jede Route und jedes Schema beschreibt. Administratoren sehen außerdem Mit Claude oder Cursor verbinden, womit sich die Einrichtung zum Verbinden von KI-Assistenten mit Exayard öffnet.

Protokolle zeigt die Anfragen an die API, die neuesten zuerst. Jede Zeile zeigt Methode, Pfad, Status, Zeit und Latenz. Klicken Sie unten auf Mehr laden, um ältere Anfragen zu sehen.

Administratoren sehen jede Anfrage. Mitglieder sehen nur die Anfragen, die nicht über eine App kamen.

Administratoren können nach App filtern und dann nach einem der Schlüssel dieser App. Jeder kann einen Endnutzer eingeben, um nur die Anfragen dieses Kunden zu sehen. Ein Endnutzer ist Ihre eigene ID für einen Ihrer Kunden. Ihr Code sendet sie mit jeder Anfrage im Header Exayard-End-User. Verwenden Sie niemals eine E-Mail-Adresse als ID.

Wählen Sie eine Zeile aus, um alle Details zu sehen, einschließlich der Anfrage-ID, der App und des Endnutzers sowie des Anfrage-Body und des Antwort-Body. Nutzen Sie die Protokolle, um zu bestätigen, dass ein Aufruf funktioniert hat, oder um herauszufinden, warum eine Integration fehlschlägt.

Administratoren sehen unter Ausgaben nach App in Einstellungen und dann Nutzung, was jede App in diesem Monat ausgegeben hat. Ihre eigenen Apps sind dort ebenfalls aufgeführt. Unter jeder App zeigt Nach Schlüssel, was jeder Schlüssel ausgegeben hat, und Top-Endnutzer zeigt die fünf Endnutzer mit den höchsten Ausgaben. Ausgaben, die keinem Schlüssel der App zugeordnet sind, erscheinen als Sonstiges.

Das monatliche KI-Limit einer App ist der Höchstbetrag, den ihre KI-Arbeit Ihr Unternehmen pro Abrechnungsmonat kosten darf. Um es festzulegen, öffnen Sie unter Ausgaben nach App das Menü Weitere Aktionen der App und klicken Sie auf Monatliches KI-Limit festlegen. Geben Sie einen Betrag in Ihrer Abrechnungswährung ein und klicken Sie auf Speichern. Speichern Sie ein leeres Feld, um das Limit zu entfernen.

Wenn die App ihr Limit erreicht, wird ihre KI-Arbeit für den Rest des Abrechnungsmonats abgelehnt, auch wenn Ihr Unternehmen noch KI-Nutzung übrig hat. Die eigenen Limits Ihres Unternehmens gelten weiterhin. KI-Arbeit, die Personen selbst starten, wird nie auf das Limit einer App angerechnet.