OneSpan Blog

OneSpan-Zeichen für neue Benutzer: Überprüfen Sie den Paketstatus und laden Sie Dateien herunter (.NET SDK)

Entwickler
Michael Williams, 7. Juli 2015
Thumbnail

Beim letzten Mal habe ich Ihnen gezeigt, wie Sie ein C # -Projekt in Microsoft Visual Studio einrichten, damit Sie dies tun können Erstellen und senden Sie ein Paket Verwenden des OneSpan Sign .NET SDK. Diese Woche werde ich einige Dinge behandeln, die Sie nach dem Senden des Pakets tun können, wie zum Beispiel:

  • Überprüfen des Paket- / Signaturstatus
  • Herunterladen der elektronisch signierten Dokumente
  • Herunterladen der Beweisübersicht

Ich werde genau dort weitermachen, wo ich aufgehört habe, im Blog der letzten Woche. Wenn Sie mitgemacht haben, haben Sie gerade in Ihrem OneSpan Sign-Posteingang nachgesehen, dass Ihr Dokumentpaket nach dem Ausführen der im Lernprogramm erstellten C # -Klasse ordnungsgemäß erstellt und gesendet wurde.

 

InboxShowingPackageCreatedWithCSharp

 

Aufbau

Ersteinrichtung

Erstellen Sie ein neues Projekt und eine neue CS-Datei für dieses Lernprogramm. Ich habe meine Datei "CheckStatusAndDownload.cs" genannt. Wenn Sie Hilfe bei diesem Setup benötigen, besuchen Sie meine vorheriger Blog für weitere Anweisungen.

Elektronische Signaturen für Einsteiger

Elektronische Signaturen für Einsteiger

In diesem 25-seitigen Leitfaden erhalten Sie eine Einführung in wichtige rechtliche Konzepte und Überlegungen zur Gestaltung digitaler Geschäftsprozesse mit elektronischen Signaturen. Jetzt herunterladen

Suchen der Paket-ID Ihres vorhandenen Projekts

Da das Paket, mit dem Sie arbeiten, zuvor erstellt wurde, müssen wir die Paket-ID für die Verwendung in diesem Projekt finden. Wenn Sie das Projekt wie oben gezeigt aus dem Posteingang der Benutzeroberfläche auswählen, hat die URL die Paket-ID wie folgt:

https://sandbox.esignlive.com/packages/yourPackageID

In der C # -Klasse, die Sie im letzten Blog erstellt haben, sehen Sie, dass Sie Zugriff auf diese Paket-ID hatten, als Sie das Paket erstellt und zum Senden des Pakets verwendet haben. Wenn Sie eine komplexere Anwendung erstellen, speichern Sie diese Paket-ID wahrscheinlich zur Verwendung in anderen Teilen Ihrer Anwendung, anstatt sie in Ihren OneSpan Sign-URLs nachzuschlagen.

Wenn Sie möchten, dass diese Paket-ID aus der C # -Klasse stammt, die im Tutorial des letzten Blogs erstellt wurde, können Sie die folgende Zeile hinzufügen: Debug.WriteLine ("PackageId:" + packageId); nach der Linie, PackageId packageId = eslClient.createPackage (superDuperPackage); . Wenn Sie diese Klasse erneut ausführen, wird jetzt die Paket-ID angezeigt, die im Ausgabefenster in Visual Studio gedruckt wird. 

 

visualStudioOutput_packageId

 

Der Code

Sie können jetzt den Code in Ihre C # -Klasse schreiben. Kopieren Sie den folgenden Code in Ihre oben erstellte Datei "CheckStatusAndDownload.cs" (oder wie auch immer Sie sie genannt haben).

using System;
using System.Diagnostics;
mit Silanis.ESL.SDK;
using Silanis.ESL.SDK.Builder;
using System.IO;

Namespace CheckStatusAndDownloadDocuments
{
    Klasse CheckStatusAndDownloadDocuments
    {
        private static String apiUrl = "https://sandbox.esignlive.com/api";
        // VERWENDEN SIE https://apps.e-signlive.com/api FÜR DIE PRODUKTION
        private static String apiKey = "YOUR_API_KEY";

        public static void Main (string [] args)
        {
            EslClient eslClient = neuer EslClient (apiKey, apiUrl);

            PackageId packageId = neue PackageId ("YOUR_PACKAGE_ID");
            DocumentPackage sentPackage = eslClient.GetPackage (packageId);

            DocumentPackageStatus packageStatus = sentPackage.Status;
            Debug.WriteLine ("Paketstatus:" + packageStatus);

            SigningStatus signingStatus = eslClient
                            .GetSigningStatus (packageId, null, null);
            Debug.WriteLine ("Signaturstatus:" + Signaturstatus);

            if (signingStatus.ToString () == "SIGNING_PENDING")
            {
                Debug.WriteLine ("Kann nicht heruntergeladen werden: Signieren nicht abgeschlossen");
            }
            sonst
            {
                byte [] zipContent = eslClient.DownloadZippedDocuments (packageId);
                File.WriteAllBytes (Directory.GetCurrentDirectory () 
                                    + "/package-documents.zip", zipContent);
                Debug.WriteLine ("Dokument-Zip-Datei heruntergeladen");

                Byte [] EvidenceContent = eslClient
                                    .DownloadEvidenceSummary (packageId);
                File.WriteAllBytes (Directory.GetCurrentDirectory () 
                                    + "/evidence-summary.pdf", EvidenceContent);
                Debug.WriteLine ("Evidence Summary Downloaded");
            } 
        }
    }
}

Schauen wir uns nun den Code genauer an. Wie beim letzten Mal definieren die ersten Zeilen Ihre Verbindungsinformationen für OneSpan Sign.

Greifen Sie auf das Paket zu

private static String apiUrl = "https://sandbox.esignlive.com/api";
// VERWENDEN SIE https://apps.e-signlive.com/api FÜR DIE PRODUKTION
private static String apiKey = "YOUR_API_KEY";

 

Stellen Sie sicher, dass Sie API_KEY anstelle des Platzhalters verwenden.

Da dies ein sehr einfaches Beispiel ist, erfolgt der Rest innerhalb der Hauptmethode. In der ersten Zeile der Hauptmethode stellen Sie mithilfe Ihrer Verbindungsinformationen von oben eine Verbindung zu OneSpan Sign her.

EslClient eslClient = neuer EslClient (apiKey, apiUrl);

 

Als Nächstes wird ein PackageId-Objekt mit der Paket-ID erstellt, die Sie oben von Ihrer URL (oder C # -Klasse zur Paketerstellung) erhalten haben. Anschließend verwenden Sie dieses PackageId-Objekt, um Ihr zuvor gesendetes Paket vom OneSpan Sign-Client abzurufen.

PackageId packageId = neue PackageId ("YOUR_PACKAGE_ID");
DocumentPackage sentPackage = eslClient.GetPackage (packageId);

 

Überprüfen Sie den Status

Nachdem Sie nun Zugriff auf das Dokumentpaket haben, können Sie Ihr Paket überprüfen, um festzustellen, wie der Paketstatus lautet. Die möglichen Werte sind ARCHIVED, COMPLETED, DECLINED, DRAFT, EXPIRED, OPTED_OUT und SENT. Drucken Sie den Status aus, damit wir ihn in der Konsole sehen können, wenn wir unsere Klasse ausführen.

 

DocumentPackageStatus packageStatus = sentPackage.Status;
Debug.WriteLine ("Paketstatus:" + packageStatus);

 

Überprüfen Sie als Nächstes den Signaturstatus des Pakets. Die möglichen Werte für diesen Wert sind ARCHIVED, CANCELED, COMPLETE, DECLINED, EXPIRED, INACTIVE, OPTED_OUT, COMPLETED und SIGNING_PENDING. Schreiben Sie dies auch in das Debug-Ausgabefenster.

SigningStatus signingStatus = eslClient.GetSigningStatus (packageId, null, null);
Debug.WriteLine ("Signaturstatus:" + Signaturstatus);

 

Laden Sie die Dateien herunter

Im letzten Teil überprüfen Sie, ob das Paket vollständig ist. Wenn dies der Fall ist, werden die Zip-Datei aller Dokumente sowie die Beweisübersicht heruntergeladen. Schreiben Sie nach jedem Schritt in die Debug-Ausgabe, damit Sie wissen, dass das Ereignis aufgetreten ist, wenn Sie die Klasse im nächsten Schritt testen.

if (signingStatus.ToString () == "SIGNING_PENDING")
{
   Debug.WriteLine ("Kann nicht heruntergeladen werden: Signieren nicht abgeschlossen");
}
sonst
{
   byte [] zipContent = eslClient.DownloadZippedDocuments (packageId);
   File.WriteAllBytes (Directory.GetCurrentDirectory () 
                       + "/package-documents.zip", zipContent);
   Debug.WriteLine ("Dokument-Zip-Datei heruntergeladen");

   Byte [] EvidenceContent = eslClient.DownloadEvidenceSummary (packageId);
   File.WriteAllBytes (Directory.GetCurrentDirectory () 
                       + "/evidence-summary.pdf", EvidenceContent);
   Debug.WriteLine ("Evidence Summary Downloaded");
}

 

Ausführen des Codes

Wenn Ihre einfache Klasse abgeschlossen ist, ist es Zeit, die C # -Klasse auszuführen. Führen Sie die Klasse über die Symbolleiste aus, indem Sie auf die Schaltfläche Start klicken.

Wenn Sie Ihr Paket noch nicht signiert haben, sollte Ihre Ausgabe wie folgt aussehen:

 

visualStudioOutput_signingNotComplete

 

Nach dem Signieren Ihres Pakets wird in Ihrem Ausgabefenster Folgendes angezeigt:

 

visualStudioOutput_downloadComplete

 

Wenn Sie jetzt zu dem Speicherort navigieren, an dem Sie Ihre Dateien gespeichert haben (wenn Sie den obigen Code verwendet haben und sich im Debug-Modus befinden, befinden sie sich im Debug-Ordner in Ihrem Projekt, in Ihrem Dateisystem), werden Sie feststellen, dass Ihre Dateien gespeichert wurden erfolgreich heruntergeladen.

 

packageFilesDownload mit .NET SDK

 

Hier hast du es. Sie haben den Status der Dateien erfolgreich überprüft und von Ihrem Paket heruntergeladen.

Danke fürs Lesen! Wenn Sie Fragen oder Funktionen haben, die aus der Perspektive eines neuen Benutzers behandelt werden sollen, können Sie diese gerne im Kommentarbereich veröffentlichen. Links zu allen Beiträgen dieser Blogserie finden Sie unten.

- Michael Williams
Twitter | Facebook | LinkedIn

 

eSignLive für neue Benutzer Blog-Serie

.NETZ C # Code Entwickler herunterladen E-Sign E-Signatur Paket SDK Unterzeichnung Status
Michael Williams
Zur Spitze gehen