REST API クイックスタート

REST APIを実行する簡易な手順を、グループ情報取得APIを使ってご紹介します。

APIキーを発行し、REST APIの実行時に使用する「認証キー」を準備します。

1. システム管理者のアカウントで、コラボフローにログインします。

2. システム管理エリアの環境設定画面を開き、REST APIの設定を表示します。

3. 任意のクライアント名を入力し、認証タイプに「HTTPヘッダー認証」を選択します。

4. 「APIキーを発行する」ボタンをクリックして、APIキーを取得します。

5. REST APIを実行するユーザーのIDとAPIキーを組み合せた文字列「{ユーザーID}/apikey:{APIキー}」を、BASE64に変換し認証キーを取得します。 例：ユーザーID「taro」、APIキー「qQzEC6cUAZfV03RvbABYm40L5mC6qUFn」の場合 「taro/apikey:qQzEC6cUAZfV03RvbABYm40L5mC6qUFn」 →「dGFyby9hcGlrZXk6cVF6RUM2Y1VBWmZWMDNSdmJBQlltNDBMNW1DNnFVRm4=」

curlコマンドでREST APIを実行してみましょう。

1. 認証キーをHTTPヘッダー「X-Collaboflow-Authorization」に指定して、グループ情報取得APIを実行します。 URL：https://{サーバー名}/{コラボフローインスタンス名}/api/index.cfm/v1/groups ※Windowsの場合はコマンドプロンプトで実行ください。 curl -X GET "https://****/***/api/index.cfm/v1/groups" -H "X-Collaboflow-Authorization:Basic dGFyby9hcGlrZXk6cVF6RUM2Y1VBWmZWMDNSdmJBQlltNDBMNW1DNnFVRm4="

2. 成功した場合、下記の様な応答が返ります。 HTTP/1.1 200

Content-Type: application/json;charset=UTF-8

{

"records": ［

{

"id": "00000000000000000000000000000000",

"parent_code": "",

"code": "root",

"name": "ルート",

"description": "",

"order": 0

},

{

"id": "D17276CF8C444488D71D61F81F1717A8",

"parent_code": "root",

"code": "本社",

"name": "本社",

"description": "",

"order": 0

}

］,

"total_count": 2,

"offset": 0,

"limit": 10,

"error": false

} その他のREST APIや詳細は「 リファレンス 」をご確認ください。

グループ情報の取得には、システム管理者の権限が必要です。

システム管理者ではないユーザーで実行した場合は、下記の様にエラー応答が返ります。