Die API für elektronische Signaturen von Certyneo in Postman
Importieren Sie die öffentliche Certyneo-Sammlung in Postman und testen Sie jeden Endpoint der REST-API v1 — Erstellung von Umschlägen, Versand, Statusverfolgung, Webhooks — mit bereits ausgefüllten Beispielanfragen.
Kostenlose und öffentliche Sammlung. Ein Certyneo-API-Schlüssel ist erforderlich, um die Anfragen auszuführen.
Warum die Certyneo-Postman-Sammlung verwenden
Die Sammlung ist für Entwickler konzipiert, die die Certyneo-API erkunden möchten, ohne die gesamte Dokumentation zu lesen, bevor sie ihre erste Anfrage stellen.
Anfragen schlüsselfertig
Jeder Endpoint der REST-API v1 ist mit einem Beispiel für eine Anfrage und Antwort dokumentiert, bereit zur Ausführung nach Eingabe Ihres API-Schlüssels.
Testumgebungen
Eine Postman-Umgebungsvariable enthält Ihren API-Schlüssel und die Basis-URL, um problemlos zwischen Ihren Konten oder Umgebungen zu wechseln.
Automatisch generierte Dokumentation
Die Postman-Dokumentation der Sammlung bleibt mit der OpenAPI-Spezifikation der Certyneo-API synchronisiert — kein Unterschied zwischen dem, was Sie testen, und dem, was in der Produktion läuft.
Testen ohne Code zu schreiben
Erstellen Sie eine Hülle, versenden Sie sie und verfolgen Sie ihren Status direkt über die Postman-Oberfläche, bevor Sie die API überhaupt in Ihre Anwendung integrieren.
Was die Sammlung abdeckt
Eine Übersicht der verfügbaren Endpoint-Gruppen in der öffentlichen Sammlung.
| Gruppe | Inhalt |
|---|---|
| Hüllen | Erstellen, versenden, auflisten, anzeigen und stornieren Sie eine Signaturhülle. |
| Dokumente | Laden Sie ein Dokument hoch oder importieren Sie es von einer URL (sourceUrl), überprüfen Sie seinen Status. |
| Unterzeichner | Fügen Sie Empfänger hinzu, legen Sie ihre Signaturreihenfolge und ihre Stufe (SES/AES) fest. |
| Webhooks | Erstellen und verwalten Sie Abos für Signaturereignisse. |
| Massensendung | Versenden Sie mehrere Hüllen in einer einzigen Anfrage für Signaturkampagnen im großen Stil. |
Die Sammlung ist öffentlich lesbar: Sie können sie ohne Konto einsehen, aber die Ausführung von Anfragen erfordert einen gültigen Certyneo API-Schlüssel.
Erste Schritte mit der Sammlung in 4 Schritten
Rechnen Sie mit weniger als 5 Minuten, um Ihre erste Anfrage zu starten.
- 1
Importieren Sie die öffentliche Sammlung
Öffnen Sie von Postman aus die öffentliche Sammlung Certyneo und klicken Sie auf "Fork" oder "Import", um sie in Ihren eigenen Bereich zu kopieren.
- 2
Generieren Sie einen Certyneo API-Schlüssel
Öffnen Sie in Ihrem Certyneo-Dashboard Einstellungen → API-Schlüssel und erstellen Sie einen Schlüssel für Postman.
- 3
Umgebungsvariable eintragen
Fügen Sie Ihren API-Schlüssel in die Umgebungsvariable der Postman-Sammlung sowie die Basis-URL der API ein.
- 4
Erste Anfrage senden
Starten Sie die Anfrage "Umschlag erstellen" und verfolgen Sie das Ergebnis direkt in Postman.
Sicherheit und Best Practices
Die Anfragen der Sammlung durchlaufen die gleiche API wie Ihre Produktionsanwendung: die gleichen Sicherheitsregeln gelten.
- Alle Anfragen werden mindestens über HTTPS/TLS 1.2 übertragen.
- Jeder API-Schlüssel ist auf die Berechtigungen beschränkt, die Sie ihm bei der Erstellung gewähren.
- Verwenden Sie für Ihre Postman-Tests einen dedizierten Testschlüssel, getrennt von Ihrem Produktionsschlüssel.
- Ein kompromittierter oder ungenutzter API-Schlüssel kann mit einem Klick aus Ihrem Certyneo-Dashboard widerrufen werden.
Häufig gestellte Fragen
Benötigen Sie einen bezahlten Plan, um die Postman-Sammlung zu verwenden?
Nein. Die Sammlung ist öffentlich und kostenlos. Die Limits Ihres Certyneo-Plans (Anzahl der Umschläge, Funktionen) gelten für die ausgeführten Anfragen, wie bei jeder API-Nutzung.
Wo finde ich meinen API-Schlüssel?
In Ihrem Certyneo-Dashboard unter Einstellungen → API-Schlüssel. Erstellen Sie einen Schlüssel für Ihre Postman-Tests.
Ist die Collection auf dem neuesten Stand mit der neuesten API-Version?
Ja, die Collection wird bei jeder Entwicklung der REST-API v1 von der offiziellen OpenAPI-Spezifikation der Certyneo-API neu generiert.
Kann ich die Webhooks von Postman aus testen?
Ja, die Collection enthält die Endpoints zum Erstellen und Auflisten Ihrer Webhook-Abonnements. Um Ereignisse lokal zu empfangen, nutzen Sie während Ihrer Tests einen HTTP-Tunnel-Service.
Entstehen Kosten für die Nutzung der Postman-Collection?
Nein, nur der Verbrauch der API selbst (Erstellung von Umschlägen) wird von Ihrem Plan abgezogen, genau wie ein klassischer API-Aufruf.
Weitere Informationen
Testen Sie die Certyneo-API in Postman
Öffentliche, kostenlose Collection, synchronisiert mit unserer Entwicklerdokumentation.