コンテンツにスキップ
KARTE Craft Developer Portal

リクエスト

Management APIは、KARTE API v2アプリのアクセストークンで利用します。リクエストの基本的な送り方を説明します。

エンドポイント

エンドポイントのベースURLは次のとおりです。

https://api.karte.io

各操作のパスは、/v2beta/cms/{リソース}/{操作} の形式です。たとえば、コンテンツ一覧を取得するパスは次のとおりです。各操作のパスは、メソッドのページを参照してください。

https://api.karte.io/v2beta/cms/content/list

HTTPメソッド

Management APIのメソッドは、すべてHTTP POSTで呼び出します。取得や絞り込みも含めて、パラメータはJSON形式のリクエストボディで指定します。

アクセストークンの渡し方

リクエストには、API v2アプリで発行したアクセストークンを Authorization ヘッダーにBearerトークンとして付与します。

Authorization: Bearer {access_token}

アクセストークンの発行方法や、操作に必要なスコープの設定は、API v2アプリと認証を参照してください。

リクエストの例

コンテンツ一覧を取得する例です。modelId は取得するコンテンツが所属するモデルのIDで、リクエストボディで指定します。

Terminal window
curl -X POST 'https://api.karte.io/v2beta/cms/content/list' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -d '{ "modelId": "{modelId}" }'

取得するコンテンツを絞り込むには、リクエストボディに filter や select などのパラメータを追加します。指定できるパラメータは、クエリのページを参照してください。