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 のマニュアルの移行することができます。
property | HTTP | リクエスト |
add | POST https://aaa.canbus.com/api/records |
レコード追加 |
update | PATCH https://aaa.canbus.com/api/records |
レコード編集 |
delete | DELETE https://aaa.canbus.com/api/records |
レコード削除 |
records | GET https://aaa.canbus.com/api/records/detail |
レコード取得 |
record_list | GET https://aaa.canbus.com/api/records |
レコード一覧取得 |
※URLの aaa 箇所にはテナントIDを入力してください。
5. Response
Canbus. API からのレスポンスとして返されるステータスコードは、次の表の通りです。
HTTP | ステータスコード | 意味 |
200 | OK | レコード取得 API の呼び出しが正常に完了した場合 |
201 | Created | レコード作成 API の呼び出しが正常に完了した場合 |
400 | Bad Request | 指定されたリクエストボディが正常に解釈できない場合(正しい JSON 形式になっていない等) |
401 | Unauthorized | 指定された API 認証情報が正しくない場合 |
403 | Forbidden | 指定された API 認証情報は正しいが、アクセス元 IP アドレスからの接続が制限されている場合 |
404 | Not Found | 指定された URL が存在しない場合 |
405 | Method Not Allowed | 指定された HTTP メソッドが当該 API では無効な場合(レコード取得 API の URL に対して PUT メソッドでアクセスした場合等) |
413 | Payload Too Large | 指定されたリクエストボディのサイズが大きすぎ、処理できない場合 |
429 | Too Many Requests API | 呼び出しがレートリミットに抵触した場合 |
500 | Internal Server Error | サーバーエラーが発生した場合 |