本記事はサインタイムが提供している各API操作の概要です。
各操作の詳細に関しては サインタイムAPI仕様書 をご覧ください。
1 書類関連 (/documents)
電子契約の書類に関連する操作は以下の通りです。
1.1 書類の一覧取得
GET /api/v1/documents
書類の一覧を取得します。
per_page パラメータで1ページあたりの書類件数、またpageパラメータでページ数の指定が可能です。
※デフォルト値 : per_page = 25 page = 1
1.2 書類の情報取得
GET /api/v1/documents/{id}{id}(書類ID)で指定した書類の情報を取得します。
1.3 書類の項目設置画面へのURLを取得
GET /api/v1/documents/{id}/builder{id}(書類ID)で指定した書類の項目設置画面へのURLを取得します。
返却されるトークン付きURLはログイン操作をせずに書類の項目設置画面へのアクセスが可能です。
1.4 書類のプレビュー画面へのURLを取得
GET /api/v1/documents/{id}/preview{id}(書類ID)で指定した書類のプレビュー画面へのURLを取得します。
返却されるトークン付きURLはログイン操作をせずに書類のプレビュー画面へのアクセスが可能です。
1.5 書類をアップロード
POST /api/v1/documents/new
新しい書類をアップロード（作成）します。
※デフォルト値 : requests_via_sms = falserequires_pades = falserequires_signer_sequencing = falseparties[][is_cc] = falseexpires_at = {30日後}
1.6 書類の送信準備
POST /api/v1/documents/{id}/annotate{id}(書類ID)で指定した書類のステータスを送信可能な状態に更新します。
1.7 書類を送信
POST /api/v1/documents/{id}/send{id}(書類ID)で指定した書類を送信します。
1.8 署名のリマインドメールを送信
POST /api/v1/documents/{id}/send_reminders{id}(書類ID)で指定した書類の署名が終わっていない署名者にリマインドメールを送信します。
1.9 書類のタグを変更
PATCH /api/v1/documents/{id}/update_tags{id}(書類ID)で指定した書類のタグの内容を更新します。
tag_listパラメータはカンマ「,」区切りで複数の値の指定が可能です。
1.10 書類の有効期限を変更
PATCH /api/v1/documents/{id}/update_expiration_date{id}(書類ID)で指定した書類の有効期限の内容を更新します。
1.11 書類の取引先情報を変更
PATCH /api/v1/documents/{id}/update_metadata{id}(書類ID)で指定した書類の取引先情報を変更します。
1.12 書類を削除
DELETE /api/v1/documents/{id}{id}(書類ID)で指定した書類を削除します。
未送信の書類、あるいは署名が完了していない書類の場合のみ削除が可能です。
*ただし完了している署名が送信者自身のものの場合は削除OKとする
2 宛名関連 (/parties)
電子契約の各宛名（送信先）に関する操作は以下の通りです。
2.1 署名のリマインドメールを送信
POST /api/v1/parties/{id}/send_reminder{id}(宛先ID)で指定した宛先(署名者)の方にリマインドメールを送信します。
3 項目関連 (/components)
電子契約の署名項目に関する操作は以下の通りです。
3.1 項目を追加
POST /api/v1/components/new
作成済みの書類の項目を設置します。
3.2 項目を取得
GET /api/v1/documents/{id}/components作成途中または送信済みの書類に設置されている各項目について、設置位置などの情報を取得できます。
また、署名完了後は各項目の入力値や、ファイルのダウンロードリンクも取得可能です。
4 テンプレート関連 (/templates)
電子契約の送信に利用が可能なテンプレートに関連する操作は以下の通りです。
4.1 テンプレートの一覧取得
GET /api/v1/templates
テンプレートの一覧を取得します。
per_page パラメータで1ページあたりのテンプレート件数、またpageパラメータでページ数の指定が可能です。
※デフォルト値 : per_page = 10 page = 1includes_trashed = false
4.2 テンプレートの情報取得
GET /api/v1/templates/{id}{id}(テンプレートID)で指定したテンプレートの情報を取得します。
4.3 テンプレートを使って書類を送信
POST /api/v1/templates/{id}/launch{id}(テンプレートID)で指定したテンプレートを使用して書類を送信します。
※デフォルト値 : requests_via_sms = falserequires_pades = false
4.4 テンプレートのタグの変更
PATCH /api/v1/templates/{id}/update_tags{id}(テンプレートID)で指定したテンプレートのタグの内容を更新します。
tag_listパラメータはカンマ「,」区切りで複数の値の指定が可能です。
4.5 テンプレートのクローン（コピー）
PATCH /api/v1/templates/{id}/clone{id}(テンプレートID)で指定したテンプレートをクローンします。
4.6 テンプレートを削除
DELETE /api/v1/templates/{id}{id}(テンプレートID)で指定したテンプレートを削除します。
書類送信履歴のないテンプレートのみ削除が可能です。
5 インポート関連 (/files)
インポート書類（スキャナ保存）に関連する操作は以下の通りです。
5.1 インポート書類の一覧取得
GET /api/v1/files
インポート書類の一覧を取得します。
per_page パラメータで1ページあたりのテンプレート件数、またpageパラメータでページ数の指定が可能です。
※デフォルト値 : per_page = 25 page = 1includes_trashed = false
5.2 インポート書類の情報取得
GET /api/v1/files/{id}{id}(インポート書類ID)で指定した書類の情報を取得します。
5.3 書類をインポート*一部追加費用あり
POST /api/v1/files/new
新しい書類をインポートします。
※デフォルト値 : requires_pades = falserequires_timestamp = false
5.4 インポート書類の情報を変更
PATCH /api/v1/files/{id}/update{id}(インポート書類ID)で指定した書類の情報を変更します。
※デフォルト値 : requires_pades = falserequires_timestamp = false
5.5 インポート書類を削除
DELETE /api/v1/files/{id}{id}(インポート書類ID)で指定した書類を削除します。
6 書類共有関連 (/shares)
書類（電子契約・インポート書類）の共有機能に関連する操作は以下の通りです。
6.1 書類の共有状況取得
GET /api/v1/shares
共有済みの書類の共有状況一覧を取得します。
6.2 書類の共有
POST /api/v1/shares/new
書類を指定の宛名に共有します。
6.3 書類の共有の取り消し
DELETE /api/v1/shares/{id}{id}{共有ID}で指定した共有を取り消します。
※インポート書類のみ対象になります。
※電子契約書類の場合はアクセスコードを指定することで閲覧権限の取り消しが可能です。
7 タイムスタンプ関連 (/timestamps)
インポート書類に対するタイムスタンプ関連の操作は以下の通りです。
7.1 タイムスタンプ付与 *追加費用あり
POST /api/v1/timestamps/new
指定のPDFにタイムスタンプを付与します。
※サインタイムでのファイル保管は行われません
8 その他 (/organizations, /users, /me, /ok)
その他ユーザーアカウントやグループなどに関連する操作は以下の通りです。
8.1 グループの一覧取得
GET /api/v1/organizations
ユーザーが所属しているグループの一覧を取得します。
8.2 グループの情報取得
GET /api/v1/organizations/{id}{id}(グループID)で指定したグループの情報を取得します。
8.2 ユーザーの一覧取得
GET /api/v1/users
グループに所属するユーザーの情報を取得します。
8.3 ユーザーの情報取得
GET /api/v1/users/{id}{id}(ユーザーID)で指定したユーザーの情報を取得します。
8.4 API実行者の情報取得
GET /api/v1/me/{id}APIを実行しているユーザーのユーザー情報を取得します。
8.5 監視
GET /api/v1/ok
関連記事
APIに関する新規のご相談は[email protected]までお問い合わせください。