Web APIのアップデートについて | クラウドサイン ヘルプセンター

Web APIのアップデートについて

Web APIのアップデートについて

5か月以上前に更新クラウドサイン運営事務局

今後の Web API アップデート

• 直近で予定されているアップデートはございません。

直近で予定されているアップデートはございません。

これまでの Web API アップデート

2024-05-17

バージョン 0.27.1

エンタープライズプランをご利用のお客様において、書類関係者でないユーザーが以下のリクエストを実行した場合、403エラーになる説明を加筆しました。

• 対象

対象

2024-03-13

バージョン 0.27.0

POST /imported_documentsに関して、以下のアップデートを行いました。

• name と uploadfile のファイル名で拡張子が不正だった場合のレスポンスメッセージを変更

  • レスポンスコードや挙動に変更なし

• SwaggerHubに400エラーになる条件を加筆

  • uploadfile のファイル名が空の場合

  • name が空で、かつ以下のいずれかの条件に該当する場合

    • uploadfile のファイル名が68文字を超える場合

    • uploadfile のファイル名の末尾が `.pdf` でない場合

    • uploadfile のファイル名が拡張子のみの場合

    • uploadfile のファイル名の拡張子の前が空白のみの場合

name と uploadfile のファイル名で拡張子が不正だった場合のレスポンスメッセージを変更

レスポンスコードや挙動に変更なし

レスポンスコードや挙動に変更なし

SwaggerHubに400エラーになる条件を加筆

uploadfile のファイル名が空の場合

uploadfile のファイル名が空の場合

name が空で、かつ以下のいずれかの条件に該当する場合

• uploadfile のファイル名が68文字を超える場合

• uploadfile のファイル名の末尾が `.pdf` でない場合

• uploadfile のファイル名が拡張子のみの場合

• uploadfile のファイル名の拡張子の前が空白のみの場合

name が空で、かつ以下のいずれかの条件に該当する場合

uploadfile のファイル名が68文字を超える場合

uploadfile のファイル名が68文字を超える場合

uploadfile のファイル名の末尾が `.pdf` でない場合

uploadfile のファイル名の末尾が `.pdf` でない場合

uploadfile のファイル名が拡張子のみの場合

uploadfile のファイル名が拡張子のみの場合

uploadfile のファイル名の拡張子の前が空白のみの場合

uploadfile のファイル名の拡張子の前が空白のみの場合

2024-03-06

バージョン 0.26.0

ファイルのアップロード上限を100件に変更しました。また、SwaggerHubに仕様の説明を加筆しました。

• POST /documents/{documentID}/filesの説明を修正

  • 400エラーになる条件として、「アップロードしたファイルの合計件数が 100件 を超えた場合」を追加

POST /documents/{documentID}/filesの説明を修正

400エラーになる条件として、「アップロードしたファイルの合計件数が 100件 を超えた場合」を追加

400エラーになる条件として、「アップロードしたファイルの合計件数が 100件 を超えた場合」を追加

2024-02-15

バージョン 0.25.0

書類インポート機能が Web API でも利用可能になりました。これに伴い、下記のアップデートを行いました。

新規追加となるエンドポイント

• 書類のPDFファイルをアップロードする

書類のPDFファイルをアップロードする

• キャビネット一覧の取得（エンタープライズプランのみ利用可能）

キャビネット一覧の取得（エンタープライズプランのみ利用可能）

2023-12-13

バージョン 0.24.2

総合行政ネットワークLGWANにて、Web APIが利用できるようになりました。これに伴い、以下説明を加筆しました。

• GET /documents/{documentID}/files/{fileID} の説明を修正

  • 400 エラーになる条件として、「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

• GET /documents/{documentID}/attachments/{attachmentID}/attached_files/{attachedFileID} の説明を修正

  • 400 エラーになる条件として、 「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

GET /documents/{documentID}/files/{fileID} の説明を修正

400 エラーになる条件として、「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

400 エラーになる条件として、「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

GET /documents/{documentID}/attachments/{attachmentID}/attached_files/{attachedFileID} の説明を修正

400 エラーになる条件として、 「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

400 エラーになる条件として、 「LGWAN環境ではダウンロードできないファイルを指定した場合」を追加

2023-07-25

バージョン 0.24.1

マイナンバーカード署名機能リリースに伴い、SwaggerHub に仕様の説明を加筆しました。

• POST /documents/{documentID} の説明を修正

  • 400エラーになる条件として、「送信者にマイナンバーカード署名が指定されている場合」を追加

• POST /documents/{documentID}/participants のパラメータ callback の説明を修正

  • 400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

• PUT /documents/{documentID}/participants のパラメータ callback の説明を修正

  • 400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

• participantsModel の callback フィールドの説明を修正

POST /documents/{documentID} の説明を修正

400エラーになる条件として、「送信者にマイナンバーカード署名が指定されている場合」を追加

400エラーになる条件として、「送信者にマイナンバーカード署名が指定されている場合」を追加

POST /documents/{documentID}/participants のパラメータ callback の説明を修正

400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

PUT /documents/{documentID}/participants のパラメータ callback の説明を修正

400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

400エラーになる条件として、「宛先にマイナンバーカード署名が指定されている場合」を追加

participantsModel の callback フィールドの説明を修正

2023-07-05

バージョン 0.24.0

組込み署名（SMS認証）機能リリースに伴い、下記のアップデートを行いました。

• 新規追加となるエンドポイント

  • 組込み署名の受信者の同意URL取得

    • 組込み署名が設定された受信者について、同意 URL と有効期限の情報が返却される

新規追加となるエンドポイント

組込み署名の受信者の同意URL取得

• 組込み署名が設定された受信者について、同意 URL と有効期限の情報が返却される

組込み署名の受信者の同意URL取得

組込み署名が設定された受信者について、同意 URL と有効期限の情報が返却される

組込み署名が設定された受信者について、同意 URL と有効期限の情報が返却される

• その他の変更点

  • participantsModel に組込み署名の設定に必要なパラメータ tel と callback を追加

  • POST /documents/{documentID} の説明を修正

    • 400 エラーになる条件として、 「組込み署名（SMS認証）が設定された受信者にリマインドを行おうとした場合」を追加

  • POST /documents/{documentID}/participants のパラメータ language_code の説明を修正

    • callback が true のとき ja（日本語）のみ指定可能なことを追加

  • POST /documents/{documentID}/participants required から email を削除

    • 組込み署名（SMS認証）では email の指定が不要になるため削除

  • PUT /documents/{documentID}/participants/{participantID} のパラメータ language_code の説明を修正

    • callback が true のとき ja（日本語）のみ指定可能なことを追加

その他の変更点

participantsModel に組込み署名の設定に必要なパラメータ tel と callback を追加

participantsModel に組込み署名の設定に必要なパラメータ tel と callback を追加

POST /documents/{documentID} の説明を修正

• 400 エラーになる条件として、 「組込み署名（SMS認証）が設定された受信者にリマインドを行おうとした場合」を追加

POST /documents/{documentID} の説明を修正

400 エラーになる条件として、 「組込み署名（SMS認証）が設定された受信者にリマインドを行おうとした場合」を追加

400 エラーになる条件として、 「組込み署名（SMS認証）が設定された受信者にリマインドを行おうとした場合」を追加

POST /documents/{documentID}/participants のパラメータ language_code の説明を修正

• callback が true のとき ja（日本語）のみ指定可能なことを追加

POST /documents/{documentID}/participants のパラメータ language_code の説明を修正

callback が true のとき ja（日本語）のみ指定可能なことを追加

callback が true のとき ja（日本語）のみ指定可能なことを追加

POST /documents/{documentID}/participants required から email を削除

• 組込み署名（SMS認証）では email の指定が不要になるため削除

POST /documents/{documentID}/participants required から email を削除

組込み署名（SMS認証）では email の指定が不要になるため削除

組込み署名（SMS認証）では email の指定が不要になるため削除

PUT /documents/{documentID}/participants/{participantID} のパラメータ language_code の説明を修正

• callback が true のとき ja（日本語）のみ指定可能なことを追加

PUT /documents/{documentID}/participants/{participantID} のパラメータ language_code の説明を修正

callback が true のとき ja（日本語）のみ指定可能なことを追加

callback が true のとき ja（日本語）のみ指定可能なことを追加

2023-05-25

バージョン 0.23.0

• 操作不可の状態(ステータス)にある書類や添付ファイルにアクセスした場合に error レスポンスのステータスコード403を返却するよう変更いたしました。

  これまで：ステータスコード406

  アップデート後：ステータスコード403

操作不可の状態(ステータス)にある書類や添付ファイルにアクセスした場合に error レスポンスのステータスコード403を返却するよう変更いたしました。

これまで：ステータスコード406

アップデート後：ステータスコード403

2023-03-03

バージョン 0.22.0

• API オプションの契約が無いユーザーからのアクセスの場合の error レスポンスのステータスコードを変更いたしました。

  これまで：ステータスコード402

  アップデート後：ステータスコード403

API オプションの契約が無いユーザーからのアクセスの場合の error レスポンスのステータスコードを変更いたしました。

これまで：ステータスコード402

アップデート後：ステータスコード403

2023-02-27

バージョン 0.21.0

• 以下のエンドポイントにおいて、requiredパラメータに不正な値を指定した場合のエラーレスポンスの不具合を修正しました。

以下のエンドポイントにおいて、requiredパラメータに不正な値を指定した場合のエラーレスポンスの不具合を修正しました。

2023-02-16

バージョン 0.21.0

高度な認証による署名機能が Web API でも利用可能になりました。

API変更内容

• 以下のエンドポイントで高度な認証による署名機能の有効／無効を切り替えるパラメータ「advanced_authn_request」を設定できます。

以下のエンドポイントで高度な認証による署名機能の有効／無効を切り替えるパラメータ「advanced_authn_request」を設定できます。

• パラメータの値にしたがい、高度な認証による署名機能 は以下のように設定されます。

  • 1 または true ：有効

  • 0 または false：無効

  • 未入力時：無効

パラメータの値にしたがい、高度な認証による署名機能 は以下のように設定されます。

1 または true ：有効

1 または true ：有効

0 または false：無効

0 または false：無効

未入力時：無効

未入力時：無効

• 受信者情報が含まれるレスポンスに 高度な認証による署名機能 が設定されているかを判別できるパラメータを追加しました。

  • participantModelにパラメータ「advanced_authn_request」を追加

受信者情報が含まれるレスポンスに 高度な認証による署名機能 が設定されているかを判別できるパラメータを追加しました。

participantModelにパラメータ「advanced_authn_request」を追加

participantModelにパラメータ「advanced_authn_request」を追加

利用時の注意点

• 受信者の言語が日本語の場合のみ利用ができます

• 日本語以外を指定した場合は400エラーが返却されます

受信者の言語が日本語の場合のみ利用ができます

日本語以外を指定した場合は400エラーが返却されます

2022-12-01

バージョン 0.20.0

受信者ファイルアップロード機能リリースに伴い、下記のアップデートを行いました。

新規追加となるエンドポイント

• 添付資料のアップロードリクエストの作成

添付資料のアップロードリクエストの作成

• 添付資料のアップロードリクエストの更新

添付資料のアップロードリクエストの更新

• 添付資料のアップロードリクエストの削除

添付資料のアップロードリクエストの削除

• 添付ファイルの取得

添付ファイルの取得

その他の変更点

• documentModel に attachment を追加します

• GET /documents, GET /team_documents に任意のパラメータ with_attachment を追加します

• PUT /documents/[docID]/decline で書類に添付ファイルが登録されている場合に添付ファイルのステータスを変更し、添付ファイルを削除します

• 「attachment」は「添付資料」（アップロードされたPDFを格納する箱）と呼称します

• 「attachedFile」 は 「添付ファイル」（実際にアップロードされるPDF）と呼称します

documentModel に attachment を追加します

GET /documents, GET /team_documents に任意のパラメータ with_attachment を追加します

PUT /documents/[docID]/decline で書類に添付ファイルが登録されている場合に添付ファイルのステータスを変更し、添付ファイルを削除します

「attachment」は「添付資料」（アップロードされたPDFを格納する箱）と呼称します

「attachedFile」 は 「添付ファイル」（実際にアップロードされるPDF）と呼称します

2022-08-22

バージョン 0.19.1

エンタープライズプランをご利用のお客様が下記のエンドポイントや操作を利用しようとすると、レスポンスコード403を返却するようになりました。

例）GET /team_documents：メンバー全員がやり取りした書類一覧の取得

例）GET /me ：APIを実行しているユーザーのユーザー情報およびチーム情報の取得

2022-05-10

バージョン 0.19.0

• 書類送信時の1ファイルあたりの上限サイズを下記のように変更しました。

  これまで：1ファイルあたりの上限10MB

  アップデート後：1ファイルあたりの上限20MB

書類送信時の1ファイルあたりの上限サイズを下記のように変更しました。

これまで：1ファイルあたりの上限10MB

アップデート後：1ファイルあたりの上限20MB

2022-01-27

バージョン 0.18.0

• クラウドサインで送信や合意を行う関係者を参加者（participant）と呼びます。今回のアップデートでは participant の状態に新たな「署名中」という状態（ステータス）を追加しました。

クラウドサインで送信や合意を行う関係者を参加者（participant）と呼びます。今回のアップデートでは participant の状態に新たな「署名中」という状態（ステータス）を追加しました。

2021-11-15 Webhookの仕様変更

• Webhookの発信元IPアドレスを追加しました。
  追加前：52.68.17.229/32　または　52.198.144.82/32
  追加後：52.68.17.229/32　または　52.198.144.82/32　または　3.112.114.42

Webhookの発信元IPアドレスを追加しました。
追加前：52.68.17.229/32　または　52.198.144.82/32
追加後：52.68.17.229/32　または　52.198.144.82/32　または　3.112.114.42

2021-10-22

バージョン 0.17.0

• 「書類を最後に処理した日時」を用いて書類一覧が取得できるようになりました

• 詳細はこちら

「書類を最後に処理した日時」を用いて書類一覧が取得できるようになりました

詳細はこちら

2021-06-21

バージョン 0.16.0

• 末尾が %%EOF で終わらない構造のファイルをアップロードするとレスポンスコード400を返すようになりました

末尾が %%EOF で終わらない構造のファイルをアップロードするとレスポンスコード400を返すようになりました

2021-02-18

バージョン 0.15.0

• 親展書類を送信できるようなりました（ビジネスプランのみ）

• 取得した書類が親展かどうかわかるようになりました

親展書類を送信できるようなりました（ビジネスプランのみ）

取得した書類が親展かどうかわかるようになりました

2021-02-08

バージョン 0.14.4

• SwaggerHub に仕様の説明を加筆しました。

SwaggerHub に仕様の説明を加筆しました。

2021-01-20

バージョン 0.14.3

• SwaggerHub に仕様の説明を加筆しました。

SwaggerHub に仕様の説明を加筆しました。

2020-12-23

バージョン 0.14.2

• SwaggerHub に仕様の説明を加筆しました。

SwaggerHub に仕様の説明を加筆しました。

2020-07-20

バージョン 0.14.0

• 下書き状態の書類を削除できるようになりました

• 入力項目の作成、更新時のリクエストパラメータx、ｙが不正なとき、レスポンスコード400を返すようになりました

下書き状態の書類を削除できるようになりました

入力項目の作成、更新時のリクエストパラメータx、ｙが不正なとき、レスポンスコード400を返すようになりました

2020-06-04

バージョン 0.13.0

• 共有先の設定・取得ができるようになりました

• GET /token を非推奨とするドキュメント修正

共有先の設定・取得ができるようになりました

GET /token を非推奨とするドキュメント修正

2020-05-19

バージョン 0.12.1

• 契約相手の名称のmaxLengthを修正

契約相手の名称のmaxLengthを修正

2020-04-27

バージョン 0.12.0

• ユーザープロファイル情報を取得できるようになりました

• POSTによるトークン取得ができるようになりました

ユーザープロファイル情報を取得できるようになりました

POSTによるトークン取得ができるようになりました

2020-04-16

バージョン 0.11.1

• ファイルの取得のresponseの記述を修正

ファイルの取得のresponseの記述を修正

2020-01-24

バージョン 0.11.0

• 取得する書類データに「書類に同意した/却下した日時」が追加されました

• 他メンバーの作った共有テンプレートを取得できるようになりました

• API経由でチェックボックスを配置できるようになりました

取得する書類データに「書類に同意した/却下した日時」が追加されました

他メンバーの作った共有テンプレートを取得できるようになりました

API経由でチェックボックスを配置できるようになりました

2019-07-25

バージョン 0.10.5

• documentModelのtiitleのmaxLengthを追記しました

documentModelのtiitleのmaxLengthを追記しました

2019-04-10

バージョン 0.10.4

• 仕様の誤りを修正

仕様の誤りを修正

2019-03-28

バージョン 0.10.3

• APIの仕様書のフォーマットをOpenAPI 3.0 にしました

APIの仕様書のフォーマットをOpenAPI 3.0 にしました

2019-03-14

バージョン 0.10.2

• /team_documentsの説明に、取得できる書類の状態としてインポート書類を追加

• 書類の状態にインポート書類を追加

/team_documentsの説明に、取得できる書類の状態としてインポート書類を追加

書類の状態にインポート書類を追加

2019-03-01

仕様変更

バージョン 0.10.1

• format: uuid と定義していた部分を、 32文字以上36文字以下の文字列 に変更します

• 定義の変更を行う項目
  ​access_token, user_id, document_id, file_id, widget_id 及び participant_id

format: uuid と定義していた部分を、 32文字以上36文字以下の文字列 に変更します

定義の変更を行う項目
​access_token, user_id, document_id, file_id, widget_id 及び participant_id

ID形式の変更

• 一部のIDについて、新規発行分より形式を変更します

• ID形式の変更を行う項目
  ​document_id, file_id, widget_id 及び participant_id

• access_token 及び user_id に関しては仕様書上のフォーマット定義のみの変更となります

• 段階的な変更を予定しています

• 該当部分については、UUID v4形式から独自形式への変更を行います。

• 文字列長が36文字から、32文字になります。

• ハイフンによる区切りがなくなります。

• ASCII文字列からなり、UUID v4 には含まれていない文字も使用されます。

一部のIDについて、新規発行分より形式を変更します

ID形式の変更を行う項目
​document_id, file_id, widget_id 及び participant_id

access_token 及び user_id に関しては仕様書上のフォーマット定義のみの変更となります

段階的な変更を予定しています

該当部分については、UUID v4形式から独自形式への変更を行います。

文字列長が36文字から、32文字になります。

ハイフンによる区切りがなくなります。

ASCII文字列からなり、UUID v4 には含まれていない文字も使用されます。

2019-02-20

バージョン 0.10.0

• 機能追加 合意締結証明書 取得

機能追加 合意締結証明書 取得

2019-02-08

バージョン 0.9.1

• 仕様の誤りを修正

仕様の誤りを修正

2019-02-06

バージョン 0.9.0

• 機能追加 書類情報取得、作成・更新

機能追加 書類情報取得、作成・更新

2018-11-08

バージョン 0.8.0

• 機能追加入力項目のラベルの設定及び取得

機能追加入力項目のラベルの設定及び取得

2018-08-22

バージョン 0.7.3

• 仕様の誤りを修正

仕様の誤りを修正

2018-06-14

バージョン 0.7.2

• 仕様の誤りを修正

仕様の誤りを修正

2018-06-01

バージョン 0.7.1

• 仕様の誤りを修正

仕様の誤りを修正

2018-05-15

バージョン 0.7.0

• 機能追加受信者に設定したアクセスコードの取得受信者がアクセスするURLの有効期限の取得

機能追加受信者に設定したアクセスコードの取得受信者がアクセスするURLの有効期限の取得

2018-05-14

バージョン 0.6.1

• 時刻フォーマットの誤りを修正

時刻フォーマットの誤りを修正

2018-05-01

バージョン 0.6.0

• アップロードできるファイル容量の上限を拡張

アップロードできるファイル容量の上限を拡張

2018-02-17

バージョン 0.5.1

• 却下機能の仕様の修正

• pageパラメータの値が不適切な場合のエラーを追加

却下機能の仕様の修正

pageパラメータの値が不適切な場合のエラーを追加

2018-02-02

バージョン 0.5.0

• エラー条件の追加

• パラメータのデフォルト値の設定を’追加

• 未設定が許容されるパラメータの記述を追加

エラー条件の追加

パラメータのデフォルト値の設定を’追加

未設定が許容されるパラメータの記述を追加

2017-12-19

バージョン 0.4.0

• 機能追加転送設定

機能追加転送設定

2017-12-12

バージョン 0.3.20171212

• エラーコード修正

エラーコード修正

2017-11-16

バージョン 0.3.20171116

• エラー条件の追加

エラー条件の追加

2017-11-10

バージョン 0.3.20171110

• 機能追加却下機能受信者の言語設定

機能追加却下機能受信者の言語設定

2017-06-22

バージョン 0.3.20170622

• 表記の誤りを修正

表記の誤りを修正

2017-05-31

バージョン 0.3.20170531

• 仕様の誤りを修正

仕様の誤りを修正

2017-04-04

バージョン 0.3.20170404

• SwaggerHub で仕様を公開

SwaggerHub で仕様を公開

2016-10-21

バージョン 0.1.0

こちらの回答で解決しましたか？😞😐😃