APIの基本

APIの基本

Sign API

署名リクエストを作成して管理するには、署名リクエストのエンドポイントを使用します。署名リクエストは、作成、再送信、キャンセルできます。また、すべての署名リクエストのリストを取得したり、特定の署名リクエストの詳細を取得したりすることもできます。

エンドポイントはhttps://{api.box.com}/2.0/sign_requestsです。次の表に、このエンドポイントで実行できる操作を示します。

操作エンドポイント説明
GET/sign_requestsすべての署名リクエストのリストを取得します。
GET/sign_requests/:id特定の署名リクエストの詳細を取得します。
POST/sign_requests署名リクエストを作成します。
POST/sign_requests/:id/resend署名リクエストを再送信します。
POST/sign_requests/:id/cancel署名リクエストをキャンセルします。

リクエストとレスポンスのパラメータの詳細については、署名リクエストAPIリファレンスを参照してください。

SignテンプレートAPI

テンプレートのリストと詳細を取得するには、Signテンプレートエンドポイントを使用します。

このAPIを使用してテンプレートを作成、編集、削除することはできません。これらのテンプレートは、Boxウェブアプリでのみ管理されます。

エンドポイントはhttps://{api.box.com}/2.0/sign_templatesです。次の表に、このエンドポイントで実行できる操作を示します。

操作エンドポイント説明
GET/sign_templatesすべてのテンプレートのリストを取得します。
GET/sign_templates/:id特定のテンプレートの詳細を取得します。

For a full details on the request and response parameters, see the Sign template request API reference.