Interface ISigningProcessApi
Signaturvorgänge der SignerApi (signer/sign/v1) aus Sicht des Fachsystems
(Konzept 6.3/6.6, API-direkt bzw. URL-Handoff): Vorgang anlegen, vorlegen, den
Nutzer über die signing_url signieren lassen, Ergebnis abholen.
public interface ISigningProcessApi
Remarks
Gerätewahl, Freigabe und Sichtprüfung sind bewusst NICHT Teil dieser API — sie
gehören der Web-UI hinter der signing_url (Konzept 4.2): das Fachsystem
kennt weder Geräte noch Freigabewege.
Methods
- AddDocuments(AddDocumentsRequest, ZedalCallContext)
Weitere Dokumente anfügen (nur im Zustand BUILD; Tarif-Batchgrenze wird serverseitig durchgesetzt).
- CancelSigningProcess(string, ZedalCallContext)
Vorgang abbrechen (BUILD/PENDING_*/REVIEW).
- CreateSigningProcess(CreateSigningProcessRequest, ZedalCallContext)
Vorgang anlegen (Zustand BUILD). Dokumente inline oder als Referenz; optionale
redirect_urlmuss auf der Allowlist des Dienstes stehen.
- GetResults(GetResultsRequest, ZedalCallContext)
Ergebnisse (signierte Dokumente + Prüfurteil des VerifierService). FAILED_PRECONDITION, solange der Vorgang nicht abgeschlossen ist.
- GetSigningProcess(string, ZedalCallContext)
Aktueller Stand des Vorgangs.
- SignAsync(IEnumerable<DocumentInput>, SigningOptions, Action<string>, string, CancellationToken, ZedalCallContext, Action<SigningProcess>)
Die Fassade für den Standardfall (Konzept AP6): Vorgang anlegen und vorlegen, die
signing_urlüberpresentSigningUrlan den Aufrufer geben (der sie dem Menschen zeigt), auf den Endzustand warten und bei Erfolg die signierten Dokumente liefern.
- SubmitAsync(IEnumerable<DocumentInput>, SigningOptions, string, ZedalCallContext)
Vorgang anlegen und vorlegen — und dann aufhören. Für Aufrufer, die die
signing_urlweitergeben und den Vorgang später über GetSigningProcess(string, ZedalCallContext), WaitForSigningProcess(string, ZedalCallContext) oder GetResults(GetResultsRequest, ZedalCallContext) weiterverfolgen (eigene Warteschlange, Skript ohne Warten). SignAsync(IEnumerable<DocumentInput>, SigningOptions, Action<string>, string, CancellationToken, ZedalCallContext, Action<SigningProcess>) baut auf diesem Schritt auf.
- SubmitSigningProcess(string, ZedalCallContext)
Vorgang vorlegen: stellt die
signing_urlmit Handoff-Token aus — diese URL zeigt das Fachsystem dem Menschen (Browser/WebView).
- WaitForSigningProcess(string, ZedalCallContext)
Long-Poll auf den nächsten relevanten Zustand (Server hält den Aufruf).
- WatchSigningProcess(string, Func<SigningProcess, Task>, CancellationToken, ZedalCallContext)
Zustandsstrom des Vorgangs (WatchSigningProcess, server-streaming). Konvention im SDK (netstandard2.0, keine IAsyncEnumerable-Zusatzabhängigkeit): je Update ein Callback; der Task endet mit dem ersten Endzustand oder bei Abbruch über das Token. Fällt der Stream weg, wirft der Task die RpcException — der Aufrufer entscheidet über den Polling-Rückfall (WaitForSigningProcess(string, ZedalCallContext)).