【新機能】Web API 0.13.0で共有先を設定できるようになりました

2020年6月4日 10:21

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

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

・・・

書類の共有先設定に関するアップデート

WebAPI利用システム上で共有先を追加することができるようになりました。
「書類の同意フローには含まない（受信者にはしない）が、合意締結があったことを共有したい」という宛先がある場合に、「共有先」をAPIから設定できる機能です。

共有メールの詳細に関してはこちら：https://help.cloudsign.jp/ja/articles/385197

■ Reportee（共有先）の追加/変更/削除ができるようになりました

既存のdocumentModelに以下のようにreportees（共有先）が追加され、reporteesを追加/変更/削除をするためのエンドポイントが用意されます。

（共有先の追加） POST /documents/{documentID}/reportees
（共有先の変更） PUT /documents/{documentID}/reportees/{reporteeID}
（共有先の削除） DELETE /documents/{documentID}/reportees/{reporteeID}
※いずれも成功時responseはdocumentModelとなります

documentModel{
...
 reportees	[
 共有先の一覧
 reporteeModel{...}]
}

reporteeModel
{
 id  string
     minLength: 32
     maxLength: 36
     共有先のID
 email string($email)
       共有先のメールアドレス
 name  string
       minLength: 1
       maxLength: 64
       共有先の名前
 organization  string
               minLength: 0
               maxLength: 64
               共有先の会社名など
}

■ 既存の書類取得APIでreportees(共有先)も取得できるようになりました

GET /documents と GET /team_documents にパラメータwith_reportees が追加されます。
with_reportees=y が指定された場合、取得したそれぞれのdocumentModel（書類）にreportees（共有先）が付加されます。

GET /tokenが非推奨となりました

セキュリティ上の観点から、GET /tokenを deprecated とするドキュメント修正を行いました。当該APIを引き続きご利用になることは可能ですが、今後はPOST /tokenをご利用になることを推奨いたします。

・・・

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

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