OneSpan-Zeichen für neue Benutzer: So erstellen und senden Sie Ihr erstes Paket (.NET SDK)

Michael Williams, 30. Juni 2015
Thumbnail

Bisher habe ich einfache Beispiele für die Verwendung der OneSpan Sign-Benutzeroberfläche und des Java SDK behandelt. Ich werde jetzt mit ein paar einfachen Blogs fortfahren, die die Verwendung des OneSpan Sign .NET SDK zeigen. In diesem Blog wird das Erstellen und Senden eines Dokumentpakets behandelt. Wenn Sie kein Sandbox-Konto haben, lesen Sie meine erster Blog wie Sie sich anmelden können.

Bedarf

Bevor Sie Ihren Code schreiben können, müssen Sie Ihre Umgebung für die Verwendung des .NET SDK einrichten.

Herunterladen des .NET SDK

Wenn Sie das .NET SDK noch nicht heruntergeladen haben, müssen Sie dies tun, bevor Sie mit diesem Handbuch fortfahren können. Über den folgenden Link gelangen Sie zu einer Seite, auf der Sie das .NET SDK herunterladen können. Außerdem finden Sie einen Link zu einigen Beispielen für die Verwendung des .NET SDK auf GitHub. Entpacken Sie das SDK an den Speicherort Ihrer Wahl.

Laden Sie das .NET SDK herunter

Herunterladen von Microsoft Visual Studio

Für diesen Blog werde ich Microsoft Visual Studio 2013 verwenden. Wenn Sie es noch nicht haben, können Sie die Community-Version kostenlos unter dem folgenden Link herunterladen. Ich werde C # als Sprache für die .NET-Bibliotheken verwenden. Sie können jede andere Umgebung verwenden, in der Sie C # und .NET verwenden können. In diesem Blog wird jedoch die Verwendung von Visual Studio beschrieben.

Laden Sie Microsoft Visual Studio Community 2013 herunter

Erstellen und senden Sie ein Paket

Jetzt, da Sie über die erforderlichen Tools verfügen, ist es Zeit, loszulegen. 

OneSpan Sign-Entwickler-Community

OneSpan Sign-Entwickler-Community

Treten Sie der OneSpan Sign Developer Community bei! Foren, Blogs, Dokumentationen, SDK-Downloads und mehr.

Tritt heute bei

Erstellen und konfigurieren Sie Ihr C # -Projekt

Gehen Sie nach dem Öffnen von Visual Studio zu Datei -> Neu -> Projekt . Ich entschied mich Windows -> Projekt leeren aus den Vorlagen und nannte mein Projekt "CreateAndSendPackage".

 

VisualStudioCreateProject

 

Wählen Sie OK. Sie sehen nun Ihre Lösung / Ihr Projekt im Projektmappen-Explorer.

Fügen Sie als Nächstes das .NET SDK als Referenz hinzu, indem Sie im Projektmappen-Explorer mit der rechten Maustaste auf Referenzen in Ihrem Projekt klicken. Wählen Sie "Verweis hinzufügen ...". Wählen Sie im daraufhin angezeigten Dialogfeld "Durchsuchen", klicken Sie unten auf die Schaltfläche "Durchsuchen ...", navigieren Sie zu der Stelle, an der Sie das .NET SDK entpackt haben, wählen Sie die drei DLL-Dateien aus und wählen Sie "Hinzufügen".

 

Füge Referenz hinzu

 

Klicken Sie abschließend mit der rechten Maustaste auf Ihr Projekt und wählen Sie Hinzufügen -> Neues Element… Wählen Sie im Popup den Abschnitt Code aus, wählen Sie Codedatei, benennen Sie die gewünschte Datei (ich habe sie "CreateAndSendPackge.cs" genannt) und wählen Sie Hinzufügen.

 

AddCodeFile

 

Sie sehen diese Datei jetzt in Ihrem Projekt im Projektmappen-Explorer.

Der Code

Öffnen Sie die soeben erstellte CS-Datei und geben Sie den folgenden Code ein.

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

Namespace CreateAndSendPackage
{
    Klasse CreateAndSendPackage
    {
        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);

            FileStream fs = File.OpenRead ("PATH_TO_YOUR_PDF");

            DocumentPackage superDuperPackage = PackageBuilder
              .NewPackageNamed ("Test Package .NET")
                .WithSettings (DocumentPackageSettingsBuilder
                    .NewDocumentPackageSettings ())
                    .WithSigner (SignerBuilder
                         .NewSignerWithEmail ("signer.email @example .com ")
                                .WithFirstName ("Vorname des Unterzeichners")
                                .WithLastName ("Nachname des Unterzeichners")
                                .WithCustomId ("Signer"))
                    .WithSigner (SignerBuilder
                         .NewSignerWithEmail ("Ihre.Mail @example .com ")
                                .WithFirstName ("Ihr Vorname")
                                .WithLastName ("Ihr Nachname"))
.WithDocument (DocumentBuilder.NewDocumentNamed ("sampleAgreement")
                                  .FromStream (fs, DocumentType.PDF)
                                  .WithSignature (SignatureBuilder
                                       .SignatureFor ("signer.email  .com ")
                                         .OnPage (0)
                                         .AtPosition (175, 165))
                                  .WithSignature (SignatureBuilder
                                       .SignatureFor ("Ihre.Mail  .com ")
                                         .OnPage (0)
                                         .AtPosition (550, 165))
                                  )
                    .Bauen();

            PackageId packageId = eslClient.CreatePackage (superDuperPackage);
            eslClient.SendPackage (packageId);
        }

    }
}

 

Wenn Sie sich den Code etwas genauer ansehen, definieren die ersten Zeilen die Bibliotheken, die Sie verwenden werden.

 

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

 

In den nächsten Zeilen werden Ihre Verbindungseinstellungen für OneSpan Sign definiert. Stellen Sie sicher, dass Sie YOUR_API_KEY durch Ihren API-Schlüssel ersetzen. Sie finden diesen Wert, indem Sie sich bei OneSpan Sign anmelden und zur Registerkarte ACCOUNT wechseln.

 

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";

 

In diesem sehr einfachen Beispiel wird der Rest des Codes innerhalb der Hauptmethode ausgeführt. Als erstes stellen Sie über die oben definierte API-URL und den API-Schlüssel eine Verbindung zum OneSpan Sign-Client her.

EslClient eslClient = neuer EslClient (apiKey, apiUrl);

 

In der nächsten Zeile erstellen Sie einen FileStream und lesen die Datei ein, die Sie mit Ihrem Paket hochladen möchten. Stellen Sie sicher, dass Sie den Platzhaltertext durch den Speicherort Ihrer PDF-Datei ersetzen.

 

FileStream fs = File.OpenRead ("PATH_TO_YOUR_PDF");

 

Als nächstes wird das Paket erstellt.

 

DocumentPackage superDuperPackage = PackageBuilder
     .NewPackageNamed ("Test Package .NET")
     .WithSettings (DocumentPackageSettingsBuilder.NewDocumentPackageSettings ())

Anschließend werden die Unterzeichner zum Paket hinzugefügt.

.WithSigner (SignerBuilder.NewSignerWithEmail ("signer.email") @example .com ")
                      .WithFirstName ("Vorname des Unterzeichners")
                      .WithLastName ("Nachname des Unterzeichners")
                      .WithCustomId ("Signer"))
          .WithSigner (SignerBuilder.NewSignerWithEmail ("your.email") @example .com ")
                      .WithFirstName ("Ihr Vorname")
                      .WithLastName ("Ihr Nachname"))

Als Nächstes wird das Dokument hinzugefügt, einschließlich der Signaturfelder für die erforderlichen Unterzeichner.

.WithDocument (DocumentBuilder.NewDocumentNamed ("sampleAgreement")
                        .FromStream (fs, DocumentType.PDF)
                        .WithSignature (SignatureBuilder
                        .SignatureFor ("signer.email @example .com ")
                           .OnPage (0)
                           .AtPosition (175, 165))
                       .WithSignature (SignatureBuilder
                       .SignatureFor ("Ihre.Mail @example .com ")
                           .OnPage (0)
                           .AtPosition (550, 165))
                       )

 

Nachdem das Paket vollständig definiert ist, erstellen Sie das Paket und senden es.

 

.Bauen();

PackageId packageId = eslClient.CreatePackage (superDuperPackage);
eslClient.SendPackage (packageId);

 

Hier hast du es. Führen Sie diesen Code einfach aus, indem Sie in der Symbolleiste Start auswählen. Anschließend sollten Sie sich bei OneSpan Sign anmelden und das soeben erstellte Paket anzeigen können.

 

InboxShowingPackageCreatedWithCSharp

 

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. Wenn Sie weitere Beiträge von mir sehen möchten, sehen Sie meine Autorenseite .

- Michael Williams
Twitter | Facebook | LinkedIn

 

eSignLive für neue Benutzer Blog-Serie