OneSpan Sign Gewusst wie: REST-Aufrufe der API von OneSpan Sign in Python

Haris Haidary, 3. August 2016
Thumbnail

Python ist eine der beliebtesten verfügbaren allgemeinen Programmiersprachen. Es wird in vielen Anwendungsbereichen verwendet, z. B. in Webanwendungen, Softwareentwicklung, Desktop-GUIs usw. Die Beliebtheit bei Entwicklern hat drei Gründe:

  • Lesbarkeit
  • Bibliotheken
  • Gemeinschaft

Python betont die Leichtigkeit, mit der ein Benutzer Code verstehen und schreiben kann. Aufgrund seiner Syntax kann der Entwickler die entsprechenden Konzepte in weniger Codezeilen als Java oder C ++ schreiben. Darüber hinaus gibt es Python seit über zwei Jahrzehnten. Daher verfügt es über eine große Standardbibliothek, die Tools für viele Anwendungen beweist. Last but not least hat Python auch eine riesige Community, in der Sie leicht Unterstützung finden können. In diesem Blog werde ich Ihnen zeigen, wie Sie REST-Aufrufe an die API von OneSpan Sign in Python ausführen.

Der Code

Für diesen Blog werde ich Python 2.7 verwenden. Wenn Sie es noch nicht installiert haben, können Sie es von der offiziellen Website herunterladen. Hier . Den vollständigen Beispielcode erhalten Sie auch von der Entwickler-Community Code-Freigabe . Als erstes möchten Sie das Modul 'Anfragen' installieren. Auf diese Weise können Sie HTTP-Anforderungen an die API von OneSpan Sign stellen. Öffnen Sie Ihre Eingabeaufforderung und geben Sie die folgende Zeile ein:

$ pip Installationsanforderungen

Pip

Erstellen Sie jetzt in Ihrem bevorzugten Texteditor eine neue Datei mit dem Namen "createAndSendPackage.py" und speichern Sie sie an einem Ort Ihrer Wahl. Kopieren Sie den folgenden Code. Ich werde weiter unten genauer darauf eingehen.

Importanforderungen
json importieren

url = "https://sandbox.esignlive.com/api/packages"

payload = json.dumps ({"documents": [{"id": "sample-contract", "name": "Test Document"}], "status": "SENT", "type": "PACKAGE", "Rollen": [{"Typ": "SIGNER", "ID": "Unterzeichner1", "Unterzeichner": [{"E-Mail": "Unterzeichner" @example .com "," Vorname ":" John "," Nachname ":" Smith "," ID ":" Signer1 "}]," Name ":" Signer1 "}]," Name ":" Beispielpaket "})

file = open ('doc1.pdf', 'rb')

files = {
     'Nutzlast': Nutzlast,
     'Datei': Datei
}

Header = {
    'Autorisierung': "Basic your_api_key",
    'accept': "application / json"
    }

response = request.post (URL, Dateien = Dateien, Header = Header)
print (response.text)

Lassen Sie uns nun den Code genauer durchgehen. In den ersten Zeilen werden die Module importiert, die für REST-Aufrufe erforderlich sind.

Importanforderungen
json importieren

Die nächste Zeile ist die Endpunkt-URL, an die Sie Ihre POST-Anfrage senden.

url = https://sandbox.esignlive.com/api/packages

Anschließend wird die JSON-Zeichenfolge erstellt, die Ihr Paket definiert. Normalerweise erstellen Sie Ihre JSON-Zeichenfolge dynamisch im Vergleich zu einer großen Zeichenfolge wie der folgenden. Ich habe mich der Einfachheit halber dafür entschieden.

payload = json.dumps ({"Dokumente": [{"ID": "Mustervertrag", "Name": "Testdokument"}], "Status": "ENTWURF", "Typ": "PAKET", "Rollen": [{"Typ": "SIGNER", "ID": "Unterzeichner1", "Unterzeichner": [{"E-Mail": "Unterzeichner" @example .com "," Vorname ":" John "," Nachname ":" Smith "," ID ":" Signer1 "}]," Name ":" Signer1 "}]," Name ":" Beispielpaket "})

Als nächstes werden die Dokumentbinärdateien gelesen und die entsprechende Anforderungsnutzlast erstellt.

file = open ('doc1.pdf', 'rb')

files = {
     'Nutzlast': Nutzlast,
     'Datei': Datei
}

Schließlich werden die Header definiert und die POST-Anforderung zum Erstellen und Senden Ihres Pakets gestellt. Stellen Sie sicher, dass Sie den API-Schlüsselplatzhalter durch Ihren eigenen Wert ersetzen.

Header = {
    'Autorisierung': "Basic your_api_key",
    'accept': "application / json"
    }

response = request.post (URL, Dateien = Dateien, Header = Header)
print (response.text)

Ausführen Ihres Codes

Öffnen Sie Ihre Eingabeaufforderung und ändern Sie das aktuelle Verzeichnis an den Speicherort, an dem Sie Ihre Datei "createAndSendPackage.py" gespeichert haben. Geben Sie dann die folgende Zeile ein:

python createAndSendPackage.py

OneSpan Sign gibt dann eine Paket-ID als Antwort zurück, die im Eingabeaufforderungsfenster gedruckt wird.

1 Wenn Sie Fragen zu diesem Blog oder zu anderen Themen bezüglich der Integration von OneSpan Sign in Ihre Anwendung haben, besuchen Sie die Entwickler-Community-Foren: https://community.onespan.com . Das war's von mir. Danke fürs Lesen! Wenn Sie diesen Beitrag hilfreich fanden, teilen Sie ihn bitte auf Facebook, Twitter oder LinkedIn.

Haris Haidary
Junior Technical Evangelist
LinkedIn | Twitter