API について

1.APIとは

異なるシステム間で情報のやり取りを行うインターフェイスのことです。

Canbus.の場合、APIを構築する外部ツールとつなげることで、レコードの追加・更新・削除、レコードの取得・レコード一覧の取得を行うことが可能です。

また、使い方によってレコードの追加や更新を同時に行えたり、自動でAPIを動かすことにより、業務効率化につなげることが可能です。

イメージ

2. APIの設定準備

① [テナントID] [アプリID] [APIキー] [APIシークレット] が表示されます。
② [テナントID] [アプリID] [APIキー] [APIシークレット] の再発行を行うことができます。
③ 「API」の利用を [有効] [無効] に設定することができます。
④ 「API」送信するデバイスをIPアドレスで識別することができます。
⑤ セットを追加します。

3. APIの基本形式

{
 ① "tenant_id": "test",
 ② "app_id": "aaaaaaaaaaaaaaa",
 ③ "api_key": "bbbbbbb",
 ④ "api_secret": "ccccccccccccccccc",
  "property": [
    {
  ]
}

①. Canbus. のテナントID を入力します。（必須）

②. 各テーブルで発行される [API権限] の [アプリID] を入力します。（必須）

③. 各テーブルで発行される [API権限] の [APIキー] を入力します。（必須）

④. 各テーブルで発行される [API権限] の [APIシークレット] を入力します。（必須）

4. APIのリクエスト一覧

Canbus. の API は、リクエスト毎にリファレンスが分かれております。
行いたい操作によって property を変更します。
※リンクをクリックすることで、各 API のマニュアルの移行することができます。

                                                                             ※URLの aaa 箇所にはテナントIDを入力してください。

5. Response

Canbus. API からのレスポンスとして返されるステータスコードは、次の表の通りです。