Management APIの概要
Management APIは、Craft Functionsや自社サーバーなどのバックエンドから、Craft Cross CMSのコンテンツやモデルを操作するためのAPIです。CDN API・Preview API・Assets APIが取得(読み取り)専用なのに対し、Management APIではコンテンツの作成・更新・削除・公開などの操作も行えます。
Management APIは、KARTE管理画面で作成するAPI v2アプリのアクセストークンで利用します。エンドポイントやリクエストの形式は、ほかのKARTE APIと同じです。
操作できるリソース
Management APIでは、次のリソースを操作できます。各リソースで利用できる操作の一覧は、メソッドのページを参照してください。
- コンテンツ
- アセット(メディアライブラリのファイル)
- コレクション
- モデル
- カスタムフィールドタイプ
認証
Management APIは、KARTEのAPI v2アプリで発行したアクセストークンで認証します。アプリのタイプは token を指定します。アプリの作成方法やスコープの設定は、API v2アプリと認証を参照してください。
このセクションの構成
- リクエスト: エンドポイント、アクセストークンの渡し方、リクエストの例
- メソッド: リソースごとに利用できる操作の一覧
- クエリ: 一覧取得で使う絞り込みパラメータ
- エラー: エラー時に返るステータスコード
各操作のパラメータやレスポンスの詳細は、Craft Cross CMSのAPIリファレンスも参照してください。