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

リクエスト

CDN APIとPreview APIへのリクエストの基本的な送り方を説明します。どちらのAPIも、エンドポイントとスコープが異なるだけで、リクエストの形式は共通です。

エンドポイント

エンドポイントのベースURLは、次の形式です。

https://{subdomain}.cdn-api.karte.io

{subdomain} には、プロジェクト固有の値が入ります。サブドメインは、KARTE管理画面の[すべてのメニュー]>[Craft]>[CMS設定]>[APIエンドポイント]で確認できます。確認方法の詳細は、API v2アプリと認証を参照してください。

ベースURLに続くパスは、メソッドごとに異なります。たとえば、公開済みのコンテンツ一覧を取得するパスは次のとおりです。各メソッドのパスは、メソッドのページを参照してください。

https://{subdomain}.cdn-api.karte.io/beta/cms/content/list

HTTPメソッド

CDN APIとPreview APIのメソッドは、すべてHTTP GETで呼び出します。取得条件は、すべてクエリパラメータで指定します。

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

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

Authorization: Bearer {access_token}

アクセストークンの発行方法は、API v2アプリと認証を参照してください。CDN APIにはCDN用のスコープを、Preview APIにはPreview用のスコープを設定したアプリのアクセストークンを使います。

リクエストの例

公開済みのコンテンツ一覧を取得する例です。modelId は取得するコンテンツが所属するモデルのIDで、必須のパラメータです。

Terminal window
curl -X GET 'https://{subdomain}.cdn-api.karte.io/beta/cms/content/list?modelId={modelId}' \
  -H 'Authorization: Bearer {access_token}'

Preview APIを利用する場合は、エンドポイントのパスとアクセストークンを、Preview API用のものに置き換えます。

Terminal window
curl -X GET 'https://{subdomain}.cdn-api.karte.io/beta/cms/content/preview/list?modelId={modelId}' \
  -H 'Authorization: Bearer {access_token}'

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