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

2020年4月27日 10:57

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

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

・・・

ユーザープロファイル取得についてのアップデート

■ 新たにGET /me APIが追加されました

ユーザーIDやメールアドレス、所属チーム情報、権限情報などのユーザープロファイルを取得できるようになりました。

システム上でクラウドサインの登録情報を表示することで、利用者の確認の手間を削減できます。所属チームや権限などのユーザー情報によってシステムの挙動を分けることで、よりセキュアな操作コントロールを行うことも可能となります。

使い方
GET /me APIを利用することで、ClientIDに紐づくユーザープロファイルを以下のようなuserModelの形で取得できます。

userModel:
  properties:
    id:
      description: ユーザーの ID
      type: string
      minLength: 32
      maxLength: 36
    email:
      description: ユーザーのメールアドレス
      type: string
    name:
      description: ユーザーの名前
      type: string
    organization:
      description: ユーザーの組織の名称
      type: string
    team:
      description: ユーザーが所属するチーム
      allOf:
        - $ref: '#/components/schemas/teamModel'
    authorities:
      description: ユーザーが保持する権限
      allOf:
        - $ref: '#/components/schemas/userAuthoritiesModel'

userAuthoritiesModel:
  properties:
    team_administrator:
      description: チーム管理権限。チームの設定変更とメンバー管理が行える。
      type: boolean
    team_document_administrator:
      description: 書類管理権限。チーム内で送受信された書類を閲覧できる。
      type: boolean
    document_approver:
      description: 承認者。チームの承認機能が有効な場合、書類の宛先に承認者として追加できる。
      type: boolean

token取得についてのアップデート

■ 新たにPOST /token APIが追加されました

GET /token APIに加え、POST /token APIも利用できるようになりました。

秘匿性の高いClientIDをURLパラメータではなく、メッセージボディに格納することが可能となり、より安全にアクセストークンを取得できるようになりました。

・・・

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

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