共通仕様

コラボフロー REST APIを利用する事で外部システムと連携し、申請書の取得/申請/判定や、組織情報の取得/登録/更新などの操作が行えます。コラボフロー REST API共通の技術情報や概要をご説明します。
各REST APIの使用方法など詳細は「リファレンス」をご確認ください。

認証

HTTPヘッダーで「X-Collaboflow-Authorization:Basic {認証キー}」を指定します。

認証キーで指定したユーザーに付与された権限の範囲で、REST APIの実行が可能です。

認証キーは、2パターンの指定方法があります。

パスワード認証

「{ユーザーID}:{パスワード}」をBASE64で符号化した文字列を指定します。

APIキー認証

「{ユーザーID}/apikey:{APIキー}」をBASE64で符号化した文字列を指定します。

APIキーはコラボフローの「システム管理 環境設定」画面にて発行します。

リクエスト

ベースURL

• https://{サーバー名}/{コラボフローインスタンス名}/api/index.cfm
  
  クラウド版でのサーバー名は「cloud.collaboflow.com」です。
  
  例：https://cloud.collaboflow.com/example/api/index.cfm
  

HTTPメソッド

• GET：取得
• POST：登録
• PUT：更新
• DELETE：削除

データフォーマット

• JSON
  
  ボディでデータを送信する場合に「Content-Type： application/json」を指定します。

レスポンス

データフォーマット

• JSON

文字コード

• UTF-8

HTTPステータスコード

• 「200」「201」の場合は正常終了、それ以外はエラーです。
  
  エラー時は下記の様にエラーメッセージが返ります。

  HTTP/1.1 400
  Content-Type: application/json;charset=UTF-8
  {
        "messages":["Unkown API"],
        "error": true
  }

日時

APIから返される日時（年月日時分秒）は必ずISO8601の形式に従っており、UTC時刻になります。

注意事項

Basic認証が有効である場合は、以下の方法でコラボフロー REST APIを利用することができます。

リクエスト元のIPアドレスを許可する

コラボフロー REST APIを実行する環境のIPアドレスを許可いただきますと、
Basic認証が有効状態でも実行することが可能です。

IPアドレスの許可設定については、 各種環境設定を行う をご参照ください。

ヘッダに認証情報を埋め込む

Base64形式でエンコードしたBasic認証の[共通ユーザー名][共通パスワード]を、コラボフロー REST APIのヘッダに埋め込みますと、Basic認証が有効状態でも実行することが可能です。

認証情報の埋め込みは、以下の形式でおこなってください。

Authorization: Basic {共通ユーザー名}:{共通パスワード}

制限事項

• リクエストやレスポンスデータは、今後項目などが追加される場合があります。
• REST APIの利用回数は、現在のところ設けていません。
  
  但し、クラウド環境において著しい負荷や障害がある場合、利用を制限させていただく場合があります。
• パッケージ版ではIISの設定変更が必要です。詳細はパッケージ版でのREST API利用準備をご確認ください。