OneSpan Signハウツー:PythonでのOneSpan SignのAPIへのREST呼び出し

Haris Haidary, 2016年8月3日
Thumbnail

Pythonは、利用可能な最も一般的な汎用プログラミング言語の1つです。Webアプリケーション、ソフトウェア開発、デスクトップGUIなど、多くのアプリケーションドメインで使用されています。開発者の間で人気があるのは、3つの理由があります。

  • 読みやすさ
  • 図書館
  • コミュニティ

Pythonは、ユーザーがコードを簡単に理解して記述できることを強調しています。その結果、その構文により、開発者はJavaまたはC ++よりも少ないコード行で同等の概念を記述できます。さらに、Pythonは20年以上前から存在しています。したがって、多くのアプリケーションに適したツールを証明する大規模な標準ライブラリがあります。最後に重要なことですが、Pythonには広大なコミュニティもあり、サポートを簡単に見つけることができます。このブログでは、PythonでOneSpan SignのAPIへのREST呼び出しを行う方法を紹介します。

コード

このブログでは、Python 2.7を使用します。まだインストールしていない場合は、公式Webサイトからダウンロードできます。ここに 。開発者コミュニティから完全なサンプルコードを入手することもできますコードシェア 。最初にしたいことは、「リクエスト」モジュールをインストールすることです。これにより、OneSpan SignのAPIにHTTPリクエストを行うことができます。コマンドプロンプトを開き、次の行を入力します。

$ pipインストールリクエスト

ピップ

次に、お気に入りのテキストエディターで、「createAndSendPackage.py」という名前の新しいファイルを作成し、任意の場所に保存します。次のコードをコピーしてください。さらに詳しく説明します。

インポート要求
jsonをインポートする

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

payload = json.dumps({"documents":[{"id": "sample-contract"、"name": "テストドキュメント"}]、"status": "SENT"、"type": "PACKAGE"、"ロール":[{"タイプ": "SIGNER"、"id": "Signer1"、"signers":[{"email": "signer @example .com "、" firstName ":" John "、" lastName ":" Smith "、" id ":" Signer1 "}]、" name ":" Signer1 "}]、" name ":"サンプルパッケージ "})

ファイル= open( 'doc1.pdf'、'rb')

ファイル= {
     「ペイロード」:ペイロード、
     'ファイル':ファイル
}

ヘッダー= {
    '承認': "基本的なyour_api_key"、
    '受け入れる': "application / json"
    }

response = requests.post(url、files = files、headers = headers)
print(response.text)

それでは、コードをさらに詳しく見ていきましょう。最初の数行は、REST呼び出しを行うために必要なモジュールをインポートします。

インポート要求
jsonをインポートする

次の行は、POSTリクエストを送信するエンドポイントのURLです。

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

次に、パッケージを定義するJSON文字列が作成されます。通常は、JSON文字列を動的に作成するのに対し、以下のような大きな文字列を作成します。私は簡単にするためにそうすることにしました。

payload = json.dumps({"documents":[{"id": "sample-contract"、"name": "テストドキュメント"}]、"status": "DRAFT"、"type": "PACKAGE"、"ロール":[{"タイプ": "SIGNER"、"id": "Signer1"、"signers":[{"email": "signer @example .com "、" firstName ":" John "、" lastName ":" Smith "、" id ":" Signer1 "}]、" name ":" Signer1 "}]、" name ":"サンプルパッケージ "})

次に、ドキュメントバイナリが読み取られ、適切なリクエストペイロードが構築されます。

ファイル= open( 'doc1.pdf'、'rb')

ファイル= {
     「ペイロード」:ペイロード、
     'ファイル':ファイル
}

最後に、ヘッダーが定義され、パッケージを作成して送信するためにPOSTリクエストが行われます。必ず、apiキーのプレースホルダーを独自の値に置き換えてください。

ヘッダー= {
    '承認': "基本的なyour_api_key"、
    '受け入れる': "application / json"
    }

response = requests.post(url、files = files、headers = headers)
print(response.text)

コードを実行する

コマンドプロンプトを開き、現在のディレクトリを「createAndSendPackage.py」ファイルを保存した場所に変更します。次に、次の行を入力します。

python createAndSendPackage.py

OneSpan Signは、コマンドプロンプトウィンドウに出力される応答としてパッケージIDを返します。

1 このブログや、OneSpan Signをアプリケーションに統合することに関するその他の質問がある場合は、開発者コミュニティフォーラムにアクセスしてください。 https://community.onespan.com 。それは私からです。読んでくれてありがとう!この投稿が役に立った場合は、Facebook、Twitter、またはLinkedInで共有してください。

ハリスハイダリー
ジュニアテクニカルエバンジェリスト
LinkedIn | ツイッター