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
Dans votre tableau de bord Certyneo, ouvrez Paramètres → Clés API et créez une clé dédiée à Postman.
- 3
Renseigner la variable d'environnement
Collez votre clé API dans la variable d'environnement de la collection Postman, ainsi que l'URL de base de l'API.
- 4
Envoyer une première requête
Lancez la requête « Créer une enveloppe » et suivez le résultat directement dans Postman.
Sécurité et bonnes pratiques
Les requêtes de la collection passent par la même API que votre application en production : les mêmes règles de sécurité s'appliquent.
- Toutes les requêtes transitent en HTTPS/TLS 1.2 minimum.
- Chaque clé API est limitée aux permissions que vous lui accordez à sa création.
- Utilisez une clé de test dédiée pour vos essais Postman, distincte de votre clé de production.
- Une clé API compromise ou inutilisée se révoque en un clic depuis votre tableau de bord Certyneo.
Häufig gestellte Fragen
Faut-il un plan payant pour utiliser la collection Postman ?
Non. La collection est publique et gratuite. Les limites de votre plan Certyneo (nombre d'enveloppes, fonctionnalités) s'appliquent aux requêtes exécutées, comme pour tout usage de l'API.
Wo finde ich meinen API-Schlüssel?
Dans votre tableau de bord Certyneo, sous Paramètres → Clés API. Créez une clé dédiée à vos tests Postman.
La collection est-elle à jour avec la dernière version de l'API ?
Oui, la collection est régénérée depuis le spec OpenAPI officiel de l'API Certyneo à chaque évolution de l'API REST v1.
Puis-je tester les webhooks depuis Postman ?
Oui, la collection contient les endpoints pour créer et lister vos abonnements webhooks. Pour recevoir les événements en local, utilisez un service de tunnel HTTP le temps de vos tests.
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.