IDFY REST APIとの簡単な統合のためのPython SDK。
Python 3.5以上をサポートします。 (3.5、3.6、3.7)
パッケージはPypiで利用できます。 pipenvの使用が推奨されます(https://pipenv.readthedocs.io):
pipenv install idfy-sdk
Pipenvなしでは簡単にインストールできますが:
pip install idfy-sdk
このSDKは、できるだけ少ない外部ライブラリを使用するように作られています。これは、このドキュメントの執筆時点でおそらく最も一般的に使用されるPythonライブラリである優れた「リクエスト」モジュール(http://docs.python-requests.org/en/master/)のみを使用します。
コードベースを変更したい開発者はそうすることを歓迎しますが、含まれているユニットテストを実行する場合は、IDFYモックサーバー(https://github.com/idfy-io/idfy-mock-server)をダウンロードして実行する必要があります。サーバーが稼働したら、しなければならないのは、SDKのルートフォルダーに移動してタイプすることだけです。
python -m unittest
Linuxベースのシステムで開発している場合は、必要に応じて「Python」を目的のPythonインタープリターに置き換えることを忘れないでください。
私たちは、多くの顧客が非常に才能のある社内開発者を持っていることを知っています。SDKを完全に彼らのニーズに合わせたい変更を顧客に勧めたいと思っています。以下にリストされているサポートチャネルに改善のための潜在的な質問や提案をお気軽に送ってください。フィードバックに感謝します。
以下の例は、特定のドキュメントの詳細を取得する方法を示しています。
# Import the SDK into your module
import idfy_sdk
# Set your credentials and desired scopes
idfy_sdk . IdfyConfiguration . set_client_credentials ( "Your client ID here" , "Your client secret here" , [ "A list containing all your desired scopes (see documentation)" ])
# Make a call to retrieve the document
service = idfy_sdk . services . SignatureService ()
document_info = service . get_document ( document_id )
print ( document_info )ASYNCメソッドを使用すると、プログラムは厳密にシングルスレッドされなくなります。 SDKは、Python 3.7でAsyncioモジュールに導入されたいくつかの機能を使用することもできます。そのため、そのバージョンまたは後でコードを実行すると、Asyncメソッドを使用すると効率と堅牢性にわずかな即興演奏が得られる可能性があります。