Canbus. API を呼び出すには、リクエストごとに認証が必要です。Canbus. API では、認証のための情報を JSON 形式のリクエストボディに含めて送信します。
リクエストボディの形式は以下の通りです。
{
"tenant_id": <tenant-id>,
"app_id": <app-id>,
"api_key": <api-key>,
"api_secret": <api-secret>,
...
}
認証情報を取得するには、テーブルで API を有効化する必要があります。API キーを取得後、以下のように JSON 文字列の中に認証情報を埋め込みます。
- tenant_id - 取得したテナント ID を指定します。
- app_id - 取得したアプリ ID を指定します。
- api_key - 取得した API キーを指定します。
- api_secret - 取得した API シークレットを指定します。
実際の API 呼び出しでは、認証情報の他に各 API に固有の情報を同一の JSON 文字列内に含めて送信します。詳細は、各 API のリファレンスページを参照してください。
リクエストボディの全体は、以下のようになります。これはレコード作成 API を呼び出す場合のサンプルです。
{
"tenant_id": "example",
"app_id": "815nh90ae1792a095685bbb3",
"api_key": "NoWARv8SkVb56Lx9",
"api_secret": "RJAAtoWMkK9O4X91qkFdOQPfXIUCrxIL",
"add": [
{
"System_Create_User": "admin"
}
]
}