- チュートリアル
Next.js
Nuxt 3
- 操作マニュアル
アカウントとログイン
コンテンツ
外部連携
- コンテンツAPI
基本操作
- マネジメントAPI（ベータ）
コンテンツ操作
サービス操作
レスポンスとエラー処理
- 画像API
APIはサービス内で複数作成することができます。
本ドキュメントでは、APIの作成・管理方法を説明します。
Information作成できるAPI数の上限はプランごとに異なります。
新規にAPIを作成する手順を説明します。
まず、管理画面左側のメニュー内で、「コンテンツ（API）」項目の3点リーダーをクリックし［新しいAPIを作成］をクリックします。
すると、APIの作成画面が表示されます。
※APIが存在しない場合は、サービスにアクセス後、自動でAPIの作成画面が表示されます。
APIを作成する際は、以下の2つの方法から選んで作成します。
以降、それぞれの方法について説明します。
APIの作成画面で［自分で決める］をクリックします。
その後、以下の手順で進めます。
APIの基本情報を入力します。
ここでは、「API名」および「エンドポイント」の2つを入力します。
API名は管理画面上で各APIを識別するための名前です。
エンドポイントはAPIのエンドポイントの最後尾のパスにあたる値です。
エンドポイントの入力条件は以下のとおりです。
APIの型を選択します。
ここではAPIレスポンスの形式について、「リスト形式」か「オブジェクト形式」かを選択することができます。
複数のコンテンツを取り扱います。
お知らせやブログなどの複数コンテンツの管理に適しています。
APIでは下記のように配列データを取得できます。
[ { message: 'おはよう' }, { message: 'こんにちは' }, { message: 'こんばんは' } ]単一のコンテンツを取り扱います。
設定情報や単体ページの情報などの単一コンテンツの管理に適しています。
APIでは下記のようにオブジェクトデータを取得できます。
{ title: 'プロフィール', profile: 'ヘッドレスCMSを勉強しています' }APIスキーマを定義します。
APIスキーマの定義では、下記3つの項目を入力します。
フィールドごとの一意なIDです。APIレスポンスのプロパティ名となります。
コンテンツを入力する際に表示されます。
コンテンツを入力する際の入力フォーム形式を指定します。
テキストフィールド、リッチエディタ、画像フィールドなど様々な種類から選択可能です。
InformationAPIスキーマの設定について、詳しくは「API設定」のページをご覧ください。
最後に［作成］をクリックすると、APIの作成が完了します。
テンプレートから作る場合、以下の3つのテンプレートから選ぶことができます。テンプレートごとに異なるAPIが作成されます。
対象のテンプレートをクリックすると作成が始まります。
しばらくすると、APIが自動で作成されます。
なお、APIごとにいくつかのサンプルコンテンツが入稿されています。
作成したAPIは、APIグループでまとめることができます。複数のサイトを1サービスで管理している場合などに便利です。
InformationAPIグループはTeamプラン、Businessプラン、Enterpriseプランでご利用いただける機能です。
プランごとに利用できる機能については、料金プランページをご覧ください。
管理画面左側のメニュー内で、「コンテンツ（API）」項目の3点リーダーをクリックし［新しいAPIグループを作成］をクリックします。
Information作成するグループのグループ名を入力し［作成する］をクリックします。
Caution同じ名前のAPIグループは作成できません。
APIをドラッグ&ドロップで移動させることで、APIをAPIグループにまとめることができます。
APIグループにマウスカーソルを合わせると表示される3点リーダーをクリックし［グループ名の編集］をクリックします。
グループ名を編集して［変更する］をクリックすると、グループ名の変更を反映できます。
APIグループにマウスカーソルを合わせると表示される3点リーダーをクリックし［グループの削除］をクリックします。
確認ダイアログで［OK］をクリックすると、APIグループを削除できます。
CautionAPIグループにAPIが所属している場合は、APIグループを削除できません。
APIを他のAPIグループにすべて移動させてから削除してください。