Canbus. API では、API ごとに異なる HTTP メソッドを使用します。例えば、レコード一覧 API やレコード取得 API では GET を使用し、レコード編集 API では PATCH が使用されます。
Canbus. API では、どの API でもリクエストボティを送信する必要があります。このため、HTTP GET メソッドでリクエストボディを送信できない制約があるツールキットでは、Canbus. API を正しく呼び出せない場合があります。
また、ツールキットによっては、PATCH や DELETE メソッドを使用することができず、POST または GET だけを使用可能な仕様になっている場合もあります。
このような場合は、代替メソッドとして POST を使用し、リクエストヘッダーまたはクエリ文字列を使用して適切に HTTP メソッドを上書きしてください。
リクエストヘッダーを使用して HTTP メソッドを上書きする
使用しているツールキットでカスタム HTTP リクエストヘッダーを送信できる場合は、リクエストヘッダー X-Http-Method-Override を使用して HTTP メソッドを上書きしてください。
例えば、レコード一覧 API を POST メソッドで呼び出すには、POST メソッドで /api/records をリクエストし、リクエストヘッダーで X-Http-Method-Override: GET を指定します。
POST /api/records HTTP/1.1 Host: example.canbus.com X-Http-Method-Override: GET
クエリ文字列を使用して HTTP メソッドを上書きする
使用しているツールキットでカスタム HTTP リクエストヘッダーを送信できない場合は、リクエストする API の URL にクエリ文字列を追加して HTTP メソッドを上書きしてください。
例えば、レコード一覧 API を POST メソッドで呼び出すには、POST メソッドで /api/records をリクエストする際、URL にクエリ文字列 x-http-method-override=GET を追加します。
POST /api/records?x-http-method-override=GET HTTP/1.1 Host: example.canbus.com