WebAPI でできること

WebAPI とは

WebAPI とは、Web 上で API のやり取りを可能にしたものです。 CELF ではユーザーが定義したテーブルに対して WebAPI を利用してデータ取得や新規登録といった操作をすることができます。 WebAPI を利用することで他システムや他サービスとの連携を実現したり、CELF のテーブルを利用した独自のアプリを作成することができるようになります。

WebAPI の利用方法

CELF では、WebAPI を利用するための認証情報として API キーを利用します。API キーは1企業IDにつき1つのみ作成することができます。 CELF で WebAPI を利用するためには、システム管理者権限を持つユーザーが以下の手順を実施します。

ちなみに

  • API キーは第三者に知られないようにしてください。不正アクセスのリスクにつながります。
  1. CELF に ログイン し、管理画面の「API 管理」タブを開きます。
  2. API キー設定で「+新規 API キー作成」ボタンをクリックします。作成後に表示される「コピー」ボタンをクリックして、作成した API キーをクリップボードにコピーできます。
../../../_images/img_01384.png
  1. テーブル公開設定で「公開」ボタンをクリックすることで、 WebAPI を利用したいテーブルを公開します。「編集」ボタンをクリックして、WebAPI の URL の一部となる API 名を変更することもできます。
../../../_images/img_02329.png

ちなみに

  • 公開できるテーブルは、ユーザーが CELF で作成したテーブルと CELF 管理テーブル「sys_user」、「sys_group」、「sys_operation_log」です。
  • CELF 管理テーブルは利用できる WebAPI が限定されます。
  1. WebAPI を利用する Web アプリで、リクエストヘッダに下記を追加して WebAPI を呼び出します。
X-CELF-API-KEY: {作成した API キー}

ちなみに

  • OAuth による WebAPI 利用も対応予定です。

WebAPI の利用制限

WebAPIを呼び出す場合は、1企業IDのユーザー数に応じた以下の制限があります。

ユーザー数 リクエスト件数／日 通信量／日 リクエスト件数／5分 通信量／5分
～100 60,000件 12GB 1,500件 300MB
101～200 120,000件 24GB 3,000件 600MB
201～300 180,000件 36GB 4,500件 900MB
301～400 240,000件 48GB 6,000件 1,200MB
401～ 100ユーザーごとに+60,000件 100ユーザーごとに+12GB 100ユーザーごとに+1,500件 100ユーザーごとに+300MB

ちなみに

  • 1日の制限を超えるとHTTP 403 Forbiddenエラーをレスポンスします。
  • 5分の制限を超えるとHTTP 429 Too Many Requestsエラーをレスポンスします。
  • 別途、有償にて制限を変更可能とする予定です。