【新機能】Web APIで新たに3つのことができるようになりました

クラウドサイン

2020年1月23日 19:16

クラウドサインでは、社内のワークフローやCRM、グループウェアなどのシステムと連携して業務を効率化していただくためにWeb APIを提供しています。

このたび、Web APIをより一層便利にご利用いただけるよう、3つの機能を追加するアップデートを実施いたしましたので、お知らせいたします。

・・・

書類の同意/却下日時取得についてのアップデート

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

書類に誰がいつ同意/却下したのかという時刻情報が、いつも使用しているシステム上で簡単に見られるようになりました。

書類の送信時刻と同意時刻を比較することで、締結完了までどのくらい時間がかかっているのかを「見える化」することも可能です。複数名の宛先を設定した際に、どこで承認業務がストップしてしまうのかを可視化することで、運用体制の改善や効率化を推進できます。

変更点1　documentModelへ以下の2つのフィールドが追加されます。

sent_at:
  description: 送信日時（RFC3339準拠）
  type: string
  format: 'YYYY-MM-DDThh:mm:ss.SSSSSSZ'

last_processed_at
  description: |
    書類を最後に処理した日時（RFC3339準拠）
    documentModel.statusが以下のいずれかである場合は、最後の同意/却下日時。participants中のparticipantModel.processed_atの最新と等しい。
    status:
      * 1 - 先方確認中
      * 2 - 締結済
      * 3 - 取消、または却下
      * 13 - インポート書類
  documentModel.statusが上記のいずれでもない場合は、書類の最終更新日時。
  type: string
  format: 'YYYY-MM-DDThh:mm:ss.SSSSSSZ'

変更点2　participantModelへ以下のフィールドが追加されます。

processed_at:
  description: 各受信者による書類の同意/却下日時（RFC3339準拠）
  type: string
  format: 'YYYY-MM-DDThh:mm:ss.SSSSSSZ'

テンプレート取得についてのアップデート

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

自身が作ったテンプレートに加え、チーム内のメンバーが共有したオリジナルテンプレートもWeb APIで取得できるようになりました。

従来は、システム連携するクライアントIDを有するメンバーが作成したテンプレートのみが利用可能でしたが「一人の管理者がテンプレートを作って、みんながそのテンプレートを使い回す」ような運用がWeb APIを利用しても可能となり、大規模な組織で多くのメンバーの方々による運用を実現できます。

使い方

・GET /documents API に with_shared_templates パラメータが追加されます。
・with_shared_templates に y 、status に 4 を指定することで、自身の作成したテンプレートに加えて、チーム内で共有されたテンプレートが取得されます。
・status が 4 以外の値の場合、with_shared_templates は無視されます。
・with_shared_templates に何も指定しない場合は、デフォルト値(x)として指定され、従来通り、チーム内で共有されたテンプレートは取得されません。

書類へのチェックボックス配置に関するアップデート

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

従来のフリーテキスト欄と押印欄に加え、チェックボックスもWeb API経由で書類に設置できるようになりました。

チェックボックスをWeb APIで設置しておけば、条項のひとつひとつにチェックを入れてもらう必要がある様式の契約書の場合でも、相手方はWebブラウザ上で簡単にチェックマークを入れることができます。

使い方
・ POST /documents/{documentID}/files/{fileID}/widgets API（widget 追加/　更新API）の type パラメータに 2 (チェックボックス) を指定することで、チェックボックスを配置できます。
・ widget 追加/更新APIに required パラメータが追加されます。
　　・チェックボックスに対して、チェックの必須/任意を指定します。
　　　　・ true = 必須、false = 任意
　　・ widget が受信者に割り当てられている場合のみ有効となります。
　　・ text=1, required=false を指定することで、任意入力のチェック
　　　ボックスのデフォルト状態をチェック入りにすることができます。
　　・送信者に割り当てられたチェックボックスのチェックを外せません。
　　　 widget の削除で代替をお願いします。
・ widget の type が 2 の場合のみ、返却される JSON に "required" のキー
　が追加されます。
・チェックを外したい場合は text に空文字を設定してください。

・・・

上記新機能を反映した仕様書は、以下にて公開しております。
https://app.swaggerhub.com/apis/CloudSign/cloudsign-web_api/

Web APIに関するお問い合わせや改善のご要望は、クラウドサインWebページの画面左下にて提供しているチャットサポート窓口にて承っております。