Certyneo (Vorschau)
Senden Sie Dokumente für eIDAS-kompatible elektronische Signatur, erstellen Sie Umschläge aus Vorlagen, und lösen Sie Abläufe für Signaturereignisse wie gesendet, signiert, abgeschlossen und abgelehnt aus.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Certyneo-Support |
| URL | https://certyneo.com/fr/contact |
| support@certyneo.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Certyneo |
| Website | https://certyneo.com |
| Datenschutzrichtlinie | https://certyneo.com/fr/legal/privacy |
| Kategorien | IT-Vorgänge; Produktivität |
Certyneo
Certyneo ist ein eIDAS-kompatibler elektronischer Signaturdienst. Dieser Connector ermöglicht es einem Fluss, Dokumente zur Signatur zu senden, in Echtzeit zu reagieren, wenn ein Signierer fungiert, und die signierte PDF- und seine Nachweisdatei an jedem Anderen Der Rest des Unternehmens speichert seine Aufzeichnungen.
Der typische Fluss ist drei Schritte: Ein Dokument landet irgendwo (eine Dokumentbibliothek, ein Postfach, eine Formularübermittlung), der Fluss erstellt und sendet einen Umschlag und einen zweiten Fluss, der durch envelope.completed Downloads der signierten PDF ausgelöst wird, und speichert ihn.
Herausgeber
Certyneo
Voraussetzungen
Sie benötigen ein Certyneo-Konto für einen Plan, der DEN API-Zugriff umfasst. Kostenlose und persönliche Pläne können API-Schlüssel erstellen und Ereignisse abonnieren, aber sie empfangen nur Ereignisse für Sandkastenumschläge – siehe bekannte Probleme und Einschränkungen unten.
So erhalten Sie Anmeldeinformationen
Der Connector authentifiziert sich mit einem Certyneo-API-Schlüssel.
- Melden Sie sich bei Certyneo an, und öffnen Sie Einstellungen → API-Schlüssel.
- Erstellen Sie einen Schlüssel. Live-Schlüssel beginnen mit
sk_live_, Sandkastenschlüssel mitsk_test_. - Wenn der Connector nach dem API-Schlüssel fragt, fügen Sie das Wort
Bearer, ein Leerzeichen und dann den Schlüssel ein , z. BBearer sk_live_abc123. . Certyneo erwartet das WortBearervor dem Schlüssel, und ein selbst eingefügter Schlüssel wird mit 401 abgelehnt.
Der Schlüssel trägt Bereiche. Eine Taste, ohne envelopes:write dass sie nicht erstellt oder gesendet werden kann, und eine Taste, ohne webhooks:write den Trigger zurückzusenden. Gewähren Sie den Bereichen, die der Fluss tatsächlich benötigt.
Testen ohne E-Mail-Nachricht
Ein Sandkastenschlüssel (sk_test_) übt die gesamte Pipeline aus, ohne eine einzelne Einladungs-E-Mail zu senden. Nichts erreicht einen echten Posteingang, was auch bedeutet, dass niemand die Signaturseite aus einer E-Mail erreichen kann. Erstellen Sie daher briefumschlag und Senden sie stattdessen ein Zugriffstoken für jeden Empfänger. Öffnen Sie https://certyneo.com/sign/<access token> den Testumschlag selbst, um den Testumschlag zu signieren.
Behandeln Sie dieses Token als Anmeldeinformationen: Jeder, der es hält, kann sich als dieser Empfänger signieren. Protokollieren Sie sie nicht, und legen Sie sie nicht in eine Kalkulationstabelle ab.
Unterstützte Operationen
Trigger
Wenn ein Umschlagereignis auftritt – wird für die von Ihnen ausgewählten Ereignisse ausgelöst, die von einem echten Webhook unterstützt werden, anstatt abfragen zu müssen. Verfügbare Ereignisse:
envelope.created, envelope.sent, envelope.completedenvelope.declinedenvelope.voidedenvelope.expired, envelope.returned_to_sender, , envelope.resubmitted, , recipient.signed, , , . recipient.approvedrecipient.viewed
Jede Nutzlast trägt Umschlag-ID, sowohl bei Umschlag- als auch bei Empfängerereignissen. Dies ist der Wert, der in die folgenden Aktionen eingespeist werden soll.
Lieferungen werden mit HMAC-SHA256 im X-Certyneo-Signature Header signiert – ein Hex-Digest des unformatierten JSON-Texts, der mit dem Abonnementschlüssel versehen ist. Überprüfen Sie sie, bevor ein Fluss für die Nutzlast fungiert.
Aktionen
| Action | Was es bewirkt |
|---|---|
| Auflisten von Vorlagen | Ihre gespeicherten Umschlagvorlagen. Macht die Vorlagenauswahl. |
| Briefumschlag erstellen | Erstellt einen DRAFT-Umschlag aus einer Vorlage oder aus hochgeladenen Dokumenten. |
| Briefumschlag senden | Versendet einen DRAFT-Umschlag an seine Empfänger. |
| Umschlag abrufen | Aktuelle Status- und Empfängerdetails. |
| Auflisten von Umschlägen | Paginierte Liste, nach Status gefiltert. |
| Dokument hochladen | Lädt eine PDF oder ein Bild hoch und gibt eine Dokument-ID zurück. |
| Signiertes Dokument herunterladen | Die signierte PDF-Datei, die Zertifikatseite enthalten. |
| Downloadüberwachungspfad | Die Nachweisdatei: wer, wann, von welcher IP, mit welchen Faktoren signiert wurde. |
| Entwurf umschlag löschen | Löscht einen Umschlag, der nie gesendet wurde. |
Bekannte Probleme und Einschränkungen
Ein gesendeter Umschlag kann nicht aus einem Fluss zurückgerufen werden.Beim Löschen des Briefumschlags wird nur Briefumschläge akzeptiert, die sich noch in ENTWURF befinden – ein Fluss, der in der Hälfte fehlgeschlagen ist, ein falsches Dokument. Nachdem ein Umschlag ausgelaufen ist, wird 409 zurückgegeben, und es gibt heute keinen Abbruchvorgang in der API.
recipient.signed wird ausgelöst, bevor die signierte PDF vorhanden ist, einschließlich des letzten Signierers. Das Zusammenstellen und Versiegeln des endgültigen Dokuments erfolgt nach diesem Ereignis, sodass jedes Mal ein Ablauf ausgelöst recipient.signed wird, der das herunterladen signierte Dokument auslöst und sofort aufruft. Dies ist kein Rennen, das Sie mit einer Verzögerung gewinnen können – auslösen envelope.completed stattdessen, was ausgelöst wird, sobald sich die PDF-Datei auf dem Datenträger befindet.
Kostenlose und persönliche Pläne erhalten nur Sandkastenereignisse. Beide können ein Abonnement erstellen, und der Trigger wird als fehlerfrei angezeigt, aber Liveumschläge erreichen es nie. Wenn ein Auslöser bei echtem Datenverkehr scheinbar nichts tut, überprüfen Sie den Plan vor allem anderen.
Verwenden Sie eine Vorlage oder Dokumente, niemals beides. Eine Vorlage enthält eigene Dokumente und eigene Signaturfelder. Wenn Sie stattdessen aus hochgeladenen Dokumenten erstellen, müssen Sie auch Felder bereitstellen – einen Umschlag, dessen Signierer zur Sendezeit nicht zur Erstellungszeit 409 signer_without_field, deren Signierer nicht zur Erstellungszeit abgelehnt wird.
Bevorzugen Sie Ankertext über Koordinaten. Das Platzieren eines Felds durch Zitat eines Ausdrucks aus dem Dokument ("Signature du client") übersteht eine Layoutänderung und benötigt keine Messung. X und Y bleiben als Fallback, sodass ein Feld, dessen Anker nicht gefunden wird, eine Literalposition behält, anstatt zu verschwinden.
Uploads sind auf 50 MB pro Dokument begrenzt.
Ein gelöschtes Dokument gibt 410 zurück, nicht 409. 409 bedeutet "noch nicht bereit, zurückkommen nach envelope.completed". 410 bedeutet, dass das signierte Dokument absichtlich unter der Aufbewahrungsrichtlinie gelöscht wurde und nie wieder zurückkommt. Eine Wiederholungsschleife sollte am 410.
Häufige Fehler und Abhilfemaßnahmen
| Antwort | Ursache | Abhilfe |
|---|---|---|
| 401 | Fehlende Taste oder Eingefügte Taste ohne Bearer vorn |
Erneutes Eingeben der Verbindung als Bearer sk_live_... |
| 403 | Der Schlüssel hat keinen Gültigkeitsbereich für diesen Vorgang. | Stellen Sie den Schlüssel erneut mit den Bereichen aus, die der Fluss benötigt. |
| 409 zum Download | Briefumschlag ist noch nicht ABGESCHLOSSEN |
envelope.completed Auslöser anstelle von Abfragen |
| 409 on send |
signer_without_field — ein Signierer hat kein Signaturfeld. |
Hinzufügen von Feldern oder Erstellen aus einer Vorlage |
| 409 beim Löschen | Der Umschlag wurde bereits gesendet. | Gesendete Umschläge können nicht gelöscht oder zurückgerufen werden |
| 410 beim Download | Das Dokument wurde unter der Aufbewahrungsrichtlinie gelöscht. | Versuchen Sie nicht mehr; Die Datei ist nicht mehr vorhanden. |
Fehler tragen sowohl eine lesbare error Nachricht als auch eine stabile codeNachricht. Verzweigung ein code – die Nachricht kann umgeschrieben werden.
Support
- Dokumentation: https://certyneo.com/developers
- Webhook-Referenz: https://certyneo.com/developers/webhooks
- Unterstützung: https://certyneo.com/support
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Required |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | True |
Aktionen
| Auflisten von Umschlägen |
Rufen Sie eine paginierte Liste von Umschlägen ab. |
| Auflisten von Vorlagen |
Gibt Ihre gespeicherten Umschlagvorlagen zurück. Wird verwendet, um die Vorlagenauswahl auf "Umschlag erstellen" zu aktivieren. |
| Briefumschlag erstellen |
Erstellen Sie einen neuen Umschlag im ENTWURFSstatus, entweder aus einer gespeicherten Vorlage oder direkt aus Dokumenten, die Sie mit "Dokument hochladen" hochgeladen haben. Füllen Sie genau eine von "Template" oder "Documents" aus. Fügen Sie mit Dokumenten auch "Felder" hinzu, damit jeder Signierer an einer beliebigen Stelle signiert werden kann . Die einfachste Möglichkeit besteht darin, einen Ausdruck aus dem Dokument in "Ankertext" zu zitieren, anstatt Koordinaten auszulösen. WICHTIG: Diese Aktion erstellt nur den Umschlag – es wird noch keine E-Mail gesendet. Fügen Sie die Aktion "Umschlag senden" direkt hinter dieser Aktion in Ihrem Fluss hinzu, um sie tatsächlich an Empfänger zu verteilen. |
| Briefumschlag senden |
Senden Sie einen DRAFT-Umschlag an seine Empfänger zur Signatur – dies ist der Schritt, der die E-Mail tatsächlich sendet. "Umschlag erstellen" speichert ihn nur als Entwurf; sie sendet nichts selbst. Verketten Sie diese Aktion immer direkt nach "Umschlag erstellen" in Ihrem Fluss, indem Sie die zurückgegebene Umschlag-ID verwenden. |
| Dokument hochladen |
Laden Sie eine PDF oder ein Bild hoch (max. 50 MB). Gibt eine Dokument-ID zurück – übergeben Sie sie an "Briefumschlag erstellen" unter "Dokumente". |
| Downloadüberwachungspfad |
Rufen Sie die Nachweisdatei für einen abgeschlossenen Umschlag ab , der signiert hat, wann, von welcher IP, mit welchen Authentifizierungsfaktoren. Archivieren Sie es zusammen mit der signierten PDF: Es ist, was ein eIDAS-Streit aktiviert. |
| Entwurf umschlag löschen |
Löschen Sie einen Umschlag, der nie gesendet wurde – ein Fluss, der halbwegs fehlgeschlagen ist, ein falsches Dokument. NUR ENTWURF: Nachdem ein Umschlag ausgelaufen ist, wird ein Fehler zurückgegeben, und Sie können ihn nicht aus einem Fluss zurückrufen. |
| Signiertes Dokument herunterladen |
Rufen Sie die signierte PDF- und Zertifikatseite ab. Erst nach Abschluss des Umschlags – vor der Rückgabe von 409 wird der Umschlag so ausgelöst, dass "Briefumschlag abgeschlossen" anstelle von Abrufen ausgelöst wird. |
| Umschlag abrufen |
Rufen Sie den aktuellen Status und details eines Umschlags ab. |
Auflisten von Umschlägen
Rufen Sie eine paginierte Liste von Umschlägen ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Welche Ergebnisseite zurückgegeben werden soll. Beginnt bei 1. |
|
|
Seitengröße
|
limit | integer |
Anzahl der Umschläge, die pro Seite zurückgegeben werden sollen. |
|
|
Status
|
status | string |
Gibt nur die Umschläge in diesem Status zurück. Lassen Sie leer, um jeden Status zurückzugeben. |
Gibt zurück
- Body
- EnvelopeList
Auflisten von Vorlagen
Gibt Ihre gespeicherten Umschlagvorlagen zurück. Wird verwendet, um die Vorlagenauswahl auf "Umschlag erstellen" zu aktivieren.
Gibt zurück
- Body
- TemplateList
Briefumschlag erstellen
Erstellen Sie einen neuen Umschlag im ENTWURFSstatus, entweder aus einer gespeicherten Vorlage oder direkt aus Dokumenten, die Sie mit "Dokument hochladen" hochgeladen haben. Füllen Sie genau eine von "Template" oder "Documents" aus. Fügen Sie mit Dokumenten auch "Felder" hinzu, damit jeder Signierer an einer beliebigen Stelle signiert werden kann . Die einfachste Möglichkeit besteht darin, einen Ausdruck aus dem Dokument in "Ankertext" zu zitieren, anstatt Koordinaten auszulösen. WICHTIG: Diese Aktion erstellt nur den Umschlag – es wird noch keine E-Mail gesendet. Fügen Sie die Aktion "Umschlag senden" direkt hinter dieser Aktion in Ihrem Fluss hinzu, um sie tatsächlich an Empfänger zu verteilen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Betreff
|
subject | True | string |
Briefumschlag Betreff / Titel. |
|
Meldung
|
message | string |
Nachricht, die empfängern angezeigt wird. |
|
|
Template
|
templateId | string |
Wählen Sie eine gespeicherte Vorlage aus. Verwenden Sie diese ODER "Dokumente", nicht beide – eine Vorlage enthält eigene Dokumente und Signaturfelder. |
|
|
Documents
|
documentIds | array of string |
Dokument-IDs aus "Dokument hochladen". Verwenden Sie diese ODER "Vorlage", nicht beide. Wenn Sie Dokumente verwenden, fügen Sie auch "Felder" hinzu – ein Umschlag, dessen Signierer kein Signaturfeld hat, wird zur Sendezeit abgelehnt. |
|
|
E-Mail-Adresse des Signierers
|
recipientEmail | True | string |
Muss mit einem der oben genannten Empfänger übereinstimmen. |
|
Dokumentnummer
|
documentIndex | integer |
Welches Dokument dieses Feld trägt, wird von 0 in der oben angegebenen Reihenfolge gezählt. Lassen Sie leer, wenn nur ein Dokument vorhanden ist. |
|
|
Seite
|
pageNumber | True | integer | |
|
Feldtyp
|
fieldType | True | string | |
|
Ankertext (empfohlen)
|
anchorText | string |
Text, der im Dokument gesucht werden soll – das Feld wird daneben platziert, sodass Sie keine Koordinaten benötigen. Die Groß-/Kleinschreibung wird beachtet und auch dann gefunden, wenn die PDF den Ausdruck durchläuft. Lassen Sie stattdessen X/Y leer, um X/Y zu verwenden. |
|
|
Ankerplatzierung
|
anchorPlacement | string |
Wo das Feld relativ zum Ankertext platziert werden soll. |
|
|
Ankerinstanz
|
anchorIndex | integer |
Welches Vorkommen verwendet werden soll, zählen von 0, wenn der Ankertext mehrmals angezeigt wird. |
|
|
X
|
x | True | number |
Punkte vom linken Rand. Wird ignoriert, wenn der Anker gefunden wird – beibehalten als Fallback, sodass das Feld nie verschwindet. |
|
Y
|
y | True | number |
Punkte vom OBEREN Rand. Wird ignoriert, wenn der Anker gefunden wird – als Fallback beibehalten. |
|
Breite
|
width | True | number | |
|
Höhe
|
height | True | number | |
|
E-Mail-Adresse des Empfängers
|
True | string | ||
|
Empfängername
|
name | string | ||
|
Role
|
role | string | ||
|
status
|
status | string | ||
|
signedAt
|
signedAt | string | ||
|
Zugriffstoken
|
accessToken | string |
Öffnet die Signaturseite dieses Empfängers im https://certyneo.com/sign/<Token>. In der Sandbox geht keine Einladungs-E-Mail aus, sodass Sie einen Testumschlag selbst signieren. Wird von "Umschlag erstellen" und "Umschlag senden" zurückgegeben , nicht durch "Umschlag abrufen", wo er leer bleibt. Behandeln Sie sie als Anmeldeinformationen: Jeder, der ihn hält, kann sich als dieser Empfänger signieren, also nicht protokollieren oder in einem Arbeitsblatt ablegen. |
|
|
Signaturebene
|
signatureLevel | string | ||
|
Läuft ab am
|
expiresAt | date-time | ||
|
Kategorie
|
category | string |
Die Geschäftsklassifizierung wird in der Umschlagliste angezeigt. Lassen Sie leer, und Certyneo leitet einen vom Betreff ab. |
|
|
Tags
|
tags | array of string |
Freiformularbeschriftungen – Projektcode, Kundenreferenz, interner Status. Bis zu 10, jeweils bis zu 40 Zeichen. Serverseitig in Kleinbuchstaben und dedupliziert. |
|
|
Language
|
locale | string |
Sprache von allem, was der Signierer sieht: Signaturseite, Einladung, Erinnerungen, Abschluss-E-Mail. BCP-47 Code, z. B. nl, nl-BE, en-GB, de, fr. Lassen Sie leer, um die Sprache des Certyneo-Kontos zu erben, das den Umschlag sendet. Ein nicht unterstützter Code wird mit einer 400 abgelehnt. |
|
|
Umleitungs-URL
|
redirectUrl | string |
Wo der Signierer nach der Signatur gesendet wird. Ersetzt die standardmäßige Certyneo-Aufruf-zu-Aktion durch eine einzelne Schaltfläche "Weiter", die hier zeigt. Muss mit https:// beginnen – alles andere wird mit einer 400 abgelehnt. |
|
|
Initialen auf jeder Seite
|
initialsOnEveryPage | boolean |
Automatisches Stempeln der Initialen des Signierers am unteren Rand jeder Seite jedes Dokuments, zusätzlich zu jedem Feld, das Sie selbst platzieren. Kein Setup pro Seite erforderlich – der Signierer füllt die Initialen einmal aus, und es wird überall angewendet. Überspringt eine Seite, auf der der Signierer bereits über ein Feld verfügt (z. B. die Signatur auf der letzten Seite). |
|
|
Workspace
|
workspaceId | string |
Erstellen Sie den Umschlag in einem freigegebenen Arbeitsbereich, damit jedes Mitglied dieses Arbeitsbereichs ihn sehen und nachverfolgen kann. Lassen Sie es leer, um sie in Ihrem eigenen Konto zu behalten. Sie müssen der Besitzer des Arbeitsbereichs sein oder mitglied sein. |
Gibt zurück
- Body
- Envelope
Briefumschlag senden
Senden Sie einen DRAFT-Umschlag an seine Empfänger zur Signatur – dies ist der Schritt, der die E-Mail tatsächlich sendet. "Umschlag erstellen" speichert ihn nur als Entwurf; sie sendet nichts selbst. Verketten Sie diese Aktion immer direkt nach "Umschlag erstellen" in Ihrem Fluss, indem Sie die zurückgegebene Umschlag-ID verwenden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Bezeichner des Briefumschlagentwurfs, der an die Empfänger gesendet werden soll. |
Gibt zurück
- Body
- Envelope
Dokument hochladen
Laden Sie eine PDF oder ein Bild hoch (max. 50 MB). Gibt eine Dokument-ID zurück – übergeben Sie sie an "Briefumschlag erstellen" unter "Dokumente".
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datei
|
file | True | file |
Pdf oder Bild, das hochgeladen werden soll, höchstens 50 MB. |
|
Dokumentname
|
name | string |
Der Name, unter dem das Dokument gespeichert werden soll. Standardmäßig wird der eigene Name der hochgeladenen Datei verwendet. |
Gibt zurück
- Body
- Document
Downloadüberwachungspfad
Rufen Sie die Nachweisdatei für einen abgeschlossenen Umschlag ab , der signiert hat, wann, von welcher IP, mit welchen Authentifizierungsfaktoren. Archivieren Sie es zusammen mit der signierten PDF: Es ist, was ein eIDAS-Streit aktiviert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Bezeichner des Umschlags, dessen Überwachungspfad Sie herunterladen möchten. |
Gibt zurück
- response
- binary
Entwurf umschlag löschen
Löschen Sie einen Umschlag, der nie gesendet wurde – ein Fluss, der halbwegs fehlgeschlagen ist, ein falsches Dokument. NUR ENTWURF: Nachdem ein Umschlag ausgelaufen ist, wird ein Fehler zurückgegeben, und Sie können ihn nicht aus einem Fluss zurückrufen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Bezeichner des zu löschenden Entwurfsumschlags. |
Gibt zurück
- Body
- DeleteResult
Signiertes Dokument herunterladen
Rufen Sie die signierte PDF- und Zertifikatseite ab. Erst nach Abschluss des Umschlags – vor der Rückgabe von 409 wird der Umschlag so ausgelöst, dass "Briefumschlag abgeschlossen" anstelle von Abrufen ausgelöst wird.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Bezeichner des Umschlags, dessen signiertes Dokument Sie herunterladen möchten. |
Gibt zurück
- response
- binary
Umschlag abrufen
Rufen Sie den aktuellen Status und details eines Umschlags ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Bezeichner des abzurufenden Umschlags. |
Gibt zurück
- Body
- Envelope
Trigger
| Wenn ein Umschlagereignis auftritt |
Löst jedes Mal einen Ablauf aus, wenn eines der ausgewählten Ereignisse auf einem Ihrer Umschläge erfolgt (z. B. signiert, abgeschlossen, abgelehnt). Unterstützt von einem Echtzeit-Webhook – keine Abfrage. |
Wenn ein Umschlagereignis auftritt
Löst jedes Mal einen Ablauf aus, wenn eines der ausgewählten Ereignisse auf einem Ihrer Umschläge erfolgt (z. B. signiert, abgeschlossen, abgelehnt). Unterstützt von einem Echtzeit-Webhook – keine Abfrage.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ereignisse
|
events | True | array of string |
Welche Umschlag-/Empfängerereignisse diesen Fluss auslösen sollen. |
Gibt zurück
Übermittelt mit HMAC-SHA256 im X-Certyneo-Signature-Header (Hex-Digest des unformatierten JSON-Texts, schlüsselt mit dem geheimen Abonnementschlüssel). Überprüfen Sie sie, bevor Sie der Nutzlast in einem Fluss vertrauen, der darauf wirkt (siehe /developers/webhooks).
- Body
- WebhookEventPayload
Definitionen
DeleteResult
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Success
|
success | boolean |
True, wenn die Ressource gelöscht wurde. |
Paginierung
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
gesamt
|
total | integer | |
|
Seite
|
page | integer | |
|
pageSize
|
pageSize | integer | |
|
pages
|
pages | integer |
Template
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Name
|
name | string | |
|
description
|
description | string | |
|
signerCount
|
signerCount | integer | |
|
documentCount
|
documentCount | integer |
TemplateList
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
data
|
data | array of Template | |
|
Paginierung
|
pagination | Pagination |
Recipient
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
E-Mail-Adresse des Empfängers
|
string | ||
|
Empfängername
|
name | string | |
|
Role
|
role | string | |
|
status
|
status | string | |
|
signedAt
|
signedAt | string | |
|
Zugriffstoken
|
accessToken | string |
Öffnet die Signaturseite dieses Empfängers im https://certyneo.com/sign/<Token>. In der Sandbox geht keine Einladungs-E-Mail aus, sodass Sie einen Testumschlag selbst signieren. Wird von "Umschlag erstellen" und "Umschlag senden" zurückgegeben , nicht durch "Umschlag abrufen", wo er leer bleibt. Behandeln Sie sie als Anmeldeinformationen: Jeder, der ihn hält, kann sich als dieser Empfänger signieren, also nicht protokollieren oder in einem Arbeitsblatt ablegen. |
Dokument
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
Name
|
name | string | |
|
mimeType
|
mimeType | string | |
|
size
|
size | integer | |
|
status
|
status | string |
Briefumschlag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
subject
|
subject | string | |
|
Nachricht
|
message | string | |
|
status
|
status | string | |
|
signatureLevel
|
signatureLevel | string | |
|
recipients
|
recipients | array of Recipient | |
|
expiresAt
|
expiresAt | string | |
|
createdAt
|
createdAt | string | |
|
completedAt
|
completedAt | string |
EnvelopeList
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
data
|
data | array of Envelope | |
|
Paginierung
|
pagination | Pagination |
WebhookEventPayload
Übermittelt mit HMAC-SHA256 im X-Certyneo-Signature-Header (Hex-Digest des unformatierten JSON-Texts, schlüsselt mit dem geheimen Abonnementschlüssel). Überprüfen Sie sie, bevor Sie der Nutzlast in einem Fluss vertrauen, der darauf wirkt (siehe /developers/webhooks).
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ereignis
|
event | string | |
|
Zeitstempel
|
timestamp | date-time | |
|
Umschlag-ID
|
data.envelopeId | string |
Immer vorhanden. Feed it into "Get envelope" or "Download signed document". |
|
Betreff
|
data.subject | string |
Nur auf Umschlagereignissen vorhanden. |
|
Status
|
data.status | string | |
|
Signaturebene
|
data.signatureLevel | string |
Auf envelope.completed und recipient.signed vorhanden. |
|
Erweiterte Signatursignierer mit einem persönlichen Schlüssel
|
data.aesSignerCount | integer |
envelope.completed on an ADVANCED envelope only. |
|
Serielles Erweitertes Signaturzertifikat
|
data.aesCertificateSerial | string |
recipient.signed, when the signer signed with a personal advanced-signature key. |
|
Erweiterte Signaturzertifikat SHA256
|
data.aesCertificateSha256 | string |
recipient.signed, when the signer signed with a personal advanced-signature key. |
|
Erweitertes Signaturmanifest SHA256
|
data.aesManifestSha256 | string |
recipient.signed, when the signer signed with a personal advanced-signature key. |
|
Erweiterte Signaturzeitstempel
|
data.aesTimestamped | boolean |
recipient.signed, when the signer signed with a personal advanced-signature key. |
|
Empfängeranzahl
|
data.recipientCount | integer |
Nur auf Umschlagereignissen vorhanden. |
|
Signierte Anzahl
|
data.signedCount | integer |
Nur auf Umschlagereignissen vorhanden. |
|
Empfänger-ID
|
data.recipientId | string |
Nur für Empfängerereignisse vorhanden. |
|
E-Mail-Adresse des Empfängers
|
data.email | string |
Nur für Empfängerereignisse vorhanden. |
|
Empfängername
|
data.name | string |
Nur für Empfängerereignisse vorhanden. |
|
Empfängerrolle
|
data.role | string |
Nur für Empfängerereignisse vorhanden. |
|
Signiert bei
|
data.signedAt | date-time |
Nur für Empfängerereignisse vorhanden. |
|
Angezeigt unter
|
data.viewedAt | date-time |
Nur für Empfängerereignisse vorhanden. |
binary
Dies ist der grundlegende Datentyp "binary".