APIを使って電子契約の送信を自動化する方法は大きく以下の2パターンあります。
本記事ではAPIを組み合わせて実装が可能ないくつかの利用例をご紹介します。
1 新規で書類を作成し、送信
複数のAPIを組み合わせて順番に実行することで、書類の作成から送信までを全て自動化することが可能になります。
また項目の設置は手動で行いたい場合や、送信前にプレビュー画面で確認を行いたい場合は、一部手動対応を行うことも可能です。
利用の流れは以下の通りです。
1.1 APIで全てのステップの自動化
1.1.1 アクセストークンの取得
GET /oauth/token
1.1.2 書類の作成
POST /api/v1/documents/new
宛名の指定や書類の詳細設定の指定もこのステップで行います。
1.1.3. 項目の設置
POST /api/v1/components/new
各署名者に対して1つ以上の項目を設置します。
1.1.4 書類の送信準備
POST /api/v1/documents/{id}/annotate
項目設置後にこのステップが入ることで、書類が送信可能な状態になります。
1.1.5 書類の送信
POST /api/v1/documents/send
1.2 項目の設置以降手動対応
1.2.1 アクセストークンの取得
GET /oauth/token
1.2.2 書類の作成
POST /api/v1/documents/new
宛名の指定や書類の詳細設定の指定もこのステップで行います。
1.2.3 書類の項目設置画面へのURLを取得
GET /api/v1/documents/{id}/builder
書類の項目設置画面へのURLを取得します。
返却されるトークン付きURLはログイン操作をせずに書類の項目設置画面へのアクセスが可能です。
1.2.4 書類の項目設置(アプリケーション)
ステップ3で取得した書類の項目設置画面URLへアクセスをし、手動で項目の設置を行います。
各署名者に対して1つ以上の項目が必要です。
1.2.5 書類のプレビュー(アプリケーション)
書類の確認を行います。
設置箇所に修正が必要な場合は「戻る」ボタンより項目設置画面へ遷移が可能です。
1.2.6 書類の送信(アプリケーション)
1.3 プレビュー以降手動対応
1.3.1 アクセストークンの取得
GET /oauth/token
1.3.2 書類の作成
POST /api/v1/documents/new
宛名の指定や書類の詳細設定の指定もこのステップで行います。
1.3.3 項目の設置
POST /api/v1/components/new
各署名者に対して1つ以上の項目を設置します。
1.3.4 書類の送信準備
POST /api/v1/documents/{id}/annotate
項目設置後にこのステップが入ることで、書類が送信可能&プレビューが可能な状態になります。
1.3.5 書類のプレビュー画面へのURLを取得
GET /api/v1/documents/{id}/preview
書類のプレビュー画面へのURLを取得します。
返却されるトークン付きURLはログイン操作をせずに書類のプレビュー画面へのアクセスが可能です。
1.3.6 書類のプレビュー(アプリケーション)
ステップ4で取得した書類のプレビュー画面URLへアクセスをし、書類の確認を行います。
設置箇所に修正が必要な場合は「戻る」ボタンより項目設置画面へ遷移が可能です。
1.3.7 書類の送信(アプリケーション)
2 事前登録したテンプレートを使い書類を作成し、送信
事前にテンプレートの登録しておくと、API経由でテンプレートを呼び出し書類の送信を行うことが可能になります。利用の流れは以下の通りです。
2.1 アクセストークンの取得
GET /oauth/token
2.2 テンプレートの呼び出し&書類の送信
POST /api/v1/templates/{id}/launch
テンプレートを呼び出し、宛名などの指定を行います。
関連記事
APIに関する新規のご相談はsales@signtime.comまでお問い合わせください。