📖 Inhaltsverzeichnis
Was ist ein API-Schlüssel?
Ein API-Schlüssel ermöglicht es Ihrer Anwendung, sich bei der Yousign-API zu authentifizieren.
Er identifiziert Ihre Organisation und ermöglicht den sicheren Austausch von Daten, Dokumenten und Diensten über API-Anfragen.
Jeder API-Schlüssel ist wie folgt definiert:
Eine Umgebung (Sandbox oder Produktionsumgebung)
Ein Geltungsbereich, der festlegt, auf welche Ressourcen der Schlüssel zugreifen kann
Eine Berechtigungsstufe (Vollzugriff oder schreibgeschützt)
Wie erstelle ich einen API-Schlüssel?
Klicken Sie im linken Menü auf den Abschnitt Entwickler:innen.
Klicken Sie auf API-Schlüssel.
Wenn dies Ihr erster API-Schlüssel ist, klicken Sie auf Starten Sie Ihre kostenlose API-Integration (Sandbox-Umgebung).
Ansonsten klicken Sie oben auf der Seite auf Neuer API-Schlüssel.
Durch die Erstellung Ihres ersten API-Schlüssels beginnt automatisch Ihre API-Testphase.
Sie müssen folgende Angaben machen:
1. Beschreibung
Geben Sie einen Namen für Ihren API-Schlüssel ein.
Dieses Feld ist optional, wird aber empfohlen, wenn Sie mehrere API-Schlüssel erstellen möchten. Verwenden Sie eine kurze Beschreibung, um den Zweck des Schlüssels festzuhalten (z. B.: „CRM-Integration – Produktion“).
2. Umgebung
Wählen Sie aus, wo der API-Schlüssel verwendet werden soll:
Sandbox: Testumgebung für die API-Integration.
Wählen Sie diese Option, wenn Sie mit Ihrer Integration beginnen oder noch keine kostenpflichtige API-Lizenz besitzen.
Produktionsumgebung: Live-Umgebung für Ihre Integration.
Nur verfügbar, wenn Sie eine API-Lizenz abgeschlossen haben.
3. Geltungsbereich
Legen Sie den Geltungsbereich Ihres API-Schlüssels fest.
Der Geltungsbereich bestimmt die maximale Menge an Ressourcen, auf die der Schlüssel zugreifen kann.
Sie können zwischen folgenden Optionen wählen:
Organisationsbereich
Der API-Schlüssel kann auf Ressourcen in allen Workspaces Ihrer Organisation zugreifen.
Diese Option ermöglicht es dem API-Schlüssel, auf alle Daten in der Organisation zuzugreifen.
Geeignet für globale Integrationen oder Integrationen auf Plattformniveau.
Workspace-Bereich
Der API-Schlüssel kann nur auf Ressourcen innerhalb ausgewählter Workspaces zugreifen.
Sie müssen bei der Erstellung einen oder mehrere Workspaces auswählen.
Ressourcen außerhalb dieser Workspaces sind nicht zugänglich.
Der Schlüssel kann weder Benutzer:innen noch Workspaces verwalten.
Mit dem Workspace-Bereich können Sie Daten zwischen verschiedenen Teams, Projekten oder Endkund:innen abgrenzen.
4. Berechtigungsstufe
Wählen Sie die Berechtigungsstufe für den API-Schlüssel aus:
Vollzugriff: Kann Ressourcen über API-Anfragen erstellen und aktualisieren.
Schreibgeschützt: Kann über API-Anfragen lediglich Informationen abrufen.
Sobald alle Felder ausgefüllt sind, klicken Sie auf API-Schlüssel erstellen.
Ihr neuer Schlüssel wird in der API-Schlüsselliste angezeigt, wo Sie Folgendes einsehen können:
Umgebung
Berechtigungsstufe
Geltungsbereich
Auf der Seite mit den API-Schlüsseln stehen Ihnen außerdem Filter und Navigationsoptionen zur Verfügung, um schnell bestimmte Schlüssel zu finden.
Wie viele API-Schlüssel kann ich erstellen?
Pro Organisation können Sie bis zu 200 aktive API-Schlüssel erstellen.