Entwicklerportal
Das Legalesign Developer Portal ist der Ort, an dem Sie Ihren API-Zugang verwalten und Ihre Organisation überwachen können.
Verwenden Sie es, um API-Schlüssel zu erstellen und zu widerrufen, die für Ihre Integration benötigten Identifier zu kopieren, Webhook-Endpunkte zu verwalten, die letzten Webhook-Zustellungen zu überprüfen und die API-Nutzung Ihrer Organisation einzusehen.
Das Portal ersetzt das ältere API-Dashboard für neue Workflows zur Verwaltung von API-Schlüsseln. Bestehende Legacy REST API-Schlüssel funktionieren weiterhin für vorhandene Integrationen, aber neue Integrationen sollten das Portal und das neue API-Schlüssel-Format verwenden.
Zugriff
Gehen Sie zu developer.legalesign.com. Melden Sie sich mit Ihrem Legalesign-Konto an. Falls Sie eine aktive Sitzung in der Web-App haben, erfolgt die Anmeldung möglicherweise automatisch.
Ihr Konto muss für die API-Entwicklung freigeschaltet sein. Wenn das Portal anzeigt, dass die Verwaltung von API-Schlüsseln für Ihren Benutzer nicht aktiviert ist, erstellen Sie ein Support-Ticket und bitten Sie um Überprüfung des API-Zugangs.
API-Schlüssel
Der Bereich API-Schlüssel ermöglicht es Ihnen, API-Schlüssel für eine Organisation zu erstellen und zu widerrufen.
Beim Erstellen eines Schlüssels wählen Sie:
- Einen Schlüsselnamen, üblicherweise die Integration oder Umgebung, die ihn verwendet.
- Die API-Schnittstelle: REST, GraphQL oder beide.
- Eine optionale Ablaufzeit.
Der Klartext-API-Schlüssel wird einmalig direkt nach der Erstellung angezeigt. Kopieren Sie ihn, bevor Sie die Seite verlassen, da er nicht erneut angezeigt werden kann.
Neue Schlüssel verwenden das Enterprise-API-Schlüssel-Format und werden als Bearer-Token gesendet:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Legacy REST-Schlüssel werden separat angezeigt, wenn sie existieren. Sie werden nur für bestehende REST-Integrationen unterstützt. Neue Integrationen sollten auf die neuen API-Schlüssel umgestellt und Legacy-Schlüssel widerrufen werden, sobald sie nicht mehr verwendet werden.
Umgebung
Der Bereich Umgebung zeigt die Organisations- und Team-Identifier, die Ihrem Konto zur Verfügung stehen.
Verwenden Sie diesen Bereich, wenn eine API-Anfrage einen Organisations- oder Team-Kontext benötigt. Insbesondere sollten REST API-Anfragen, die innerhalb einer Organisation agieren, den Organisations-Header enthalten:
X-Organisation: <organisation-id>
Das Portal zeigt die GraphQL- und REST-Identifier nebeneinander an, sofern beide verfügbar sind.
Wenn Ihr REST API-Benutzer sich im Sandbox-Modus befindet, zeigt der Bereich Umgebung auch die genehmigten Sandbox-Empfänger-E-Mail-Adressen an. Der Sandbox-Modus beschränkt REST-Dokument-Sendungen auf diese Adressen.
Webhooks
Der Bereich Webhooks ermöglicht es Ihnen, Webhook-Endpunkte zu erstellen, zu bearbeiten, zu deaktivieren und zu löschen.
Für jeden Webhook wählen Sie:
- Die Endpunkt-URL.
- Den Ereignistyp.
- Den Gruppenumfang oder alle Gruppen.
- Ob der Webhook aktiviert ist.
Das Portal zeigt außerdem die letzten Zustellversuche der Webhooks an. Verwenden Sie die Protokollansicht, um Ereignispayloads, Zustellstatus und kürzliche Fehler zu prüfen.
Zur Unterstützung der Webhook-Entwicklung können Sie Webhook-Ereignisse auf dieser Seite auch manuell auslösen.
Für die automatisierte Einrichtung kann die Webhook-Konfiguration ebenfalls über die API verwaltet werden. Details zur Integration finden Sie im Webhooks-Leitfaden.
Nutzung
Der Bereich Nutzung fasst die letzten API-Aktivitäten für die ausgewählte Organisation zusammen.
Verwenden Sie ihn, um Folgendes zu überprüfen:
- Gesamtzahl der Anfragen.
- Welche Schlüssel verwendet wurden.
- Top-Operationen.
- Anzahl autorisierter und abgelehnter Anfragen.
- Anfrageaktivität über die Zeit.
Dies ist der erste Ort, um nach der Erstellung eines Schlüssels und dem Senden einer Testanfrage nachzusehen. Er hilft zu bestätigen, ob der Schlüssel verwendet wird und ob Anfragen akzeptiert oder abgelehnt werden.
Organisations-Admin
Organisations-Admins erhalten einen umfassenderen Verwaltungsüberblick über ihre Organisation.
Je nach Ihren Berechtigungen kann dieser Bereich folgende Punkte enthalten:
- Organisationsbasierte API-Schlüssel.
- Aktive und widerrufene Schlüssel.
- Nutzung aller Organisations-Schlüssel.
- API-Schlüssel-Audit-Ereignisse.
- Organisations-Webhooks.
Verwenden Sie diese Ansicht, um Zugriffe zu überprüfen, Schlüssel von Organisationsbenutzern zu widerrufen und kürzliche Änderungen im Lebenszyklus von API-Schlüsseln zu auditieren.
