Entwicklerportal
Das Legalesign Developer Portal ist der Ort, an dem Sie Ihren API-Zugriff verwalten und Ihre Organisation beaufsichtigen können.
Verwenden Sie es, um API-Schlüssel zu erstellen und zu widerrufen, die für Ihre Integration benötigten Identifikatoren zu kopieren, Webhook-Endpunkte zu verwalten, kürzliche Webhook-Zustellungen zu überprüfen und die API-Nutzung Ihrer Organisation einzusehen.
Das Portal ersetzt das ältere API-Dashboard für neue Workflows im API-Schlüssel-Management. 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.
Access
Gehen Sie zu developer.legalesign.com. Melden Sie sich mit Ihrem Legalesign-Konto an. Sie können sich automatisch anmelden, wenn Sie eine aktive Sitzung in der Web-App haben.
Ihr Konto muss für die API-Entwicklung freigeschaltet sein. Wenn das Portal anzeigt, dass die API-Schlüsselverwaltung für Ihren Benutzer nicht aktiviert ist, erstellen Sie ein Support-Ticket und bitten Sie um die Überprüfung des API-Zugriffs.
API Keys
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üsselname, normalerweise die Integration oder Umgebung, die ihn verwenden wird.
- Die API-Schnittstelle: REST, GraphQL oder beide.
- Eine optionale Ablaufzeit.
Der Klartext-API-Schlüssel wird einmalig unmittelbar 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. Migrieren Sie neue Integrationen auf die neuen API-Schlüssel und widerrufen Sie Legacy-Schlüssel, wenn sie nicht mehr verwendet werden.
Environment
Der Bereich Environment zeigt die für Ihr Konto verfügbaren Organisations- und Team-Identifikatoren an.
Verwenden Sie diesen Bereich, wenn eine API-Anfrage einen Organisations- oder Teamkontext benötigt. Insbesondere sollten REST-API-Anfragen, die innerhalb einer Organisation agieren, den Organisationsheader einschließen:
X-Organisation: <organisation-id>
Das Portal zeigt die GraphQL- und REST-Identifikatoren nebeneinander an, wenn beide verfügbar sind.
Wenn Ihr REST-API-Benutzer im Sandbox-Modus ist, zeigt der Bereich Environment Ihr aktuelles Throttling-Limit (100 Anrufe pro Stunde).
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 auch kürzliche Zustellversuche von Webhooks an. Nutzen Sie die Protokollansicht, um Ereignis-Payloads, Zustellstatus und kürzliche Fehlschläge 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 auch über die API verwaltet werden. Details zur Integration finden Sie im Webhooks-Leitfaden.
Usage
Der Bereich Usage fasst die jüngste API-Aktivität für die ausgewählte Organisation zusammen.
Verwenden Sie ihn, um zu prüfen:
- Gesamtanrufvolumen.
- Welche Schlüssel verwendet wurden.
- Top-Operationen.
- Anzahl autorisierter und abgelehnter Anfragen.
- Anfrageaktivität über die Zeit.
Dies ist der erste Ort, an dem Sie nach der Erstellung eines Schlüssels und Durchführung einer Testanfrage nachsehen sollten. Es hilft zu bestätigen, ob der Schlüssel verwendet wird und ob Anfragen akzeptiert oder abgelehnt werden.
Organisation Admin
Organisationsadministratoren können eine umfassendere Verwaltungsansicht für ihre Organisation sehen.
Je nach Ihren Berechtigungen kann dieser Bereich umfassen:
- Organisationsweite API-Schlüssel.
- Aktive und widerrufene Schlüssel.
- Nutzung über Organisationsschlüssel.
- Audit-Ereignisse zu API-Schlüsseln.
- Organisations-Webhooks.
Nutzen Sie diese Ansicht, um Zugriffe zu überprüfen, Schlüssel von Organisationsnutzern zu widerrufen und jüngste Änderungen im Lebenszyklus von API-Schlüsseln zu auditieren.
