- チュートリアル
Next.js
Nuxt 3
- 操作マニュアル
アカウントとログイン
コンテンツ
外部連携
- コンテンツAPI
基本操作
- マネジメントAPI（ベータ）
コンテンツ操作
サービス操作
レスポンスとエラー処理
- 画像API
POST APIを用いることで、コンテンツの入稿をAPI経由で行うことができます。
InformationPOST APIリクエストの際に必要な認証キーです。
デフォルト権限もしくは個別権限で「POST」を有効にして、リクエストヘッダーに含めて送信してください。
CautionX-MICROCMS-API-KEYが判別できると、第三者による不正なコンテンツの操作が可能となります。お取り扱いには十分ご注意ください。詳細は「APIキー（APIの認証と権限管理）」をご覧ください。
下書き状態、または公開終了状態でコンテンツを作成するためのパラメータです。
status=draftをパラメータとして追加してください。status=closedをパラメータとして追加してください。APIスキーマに沿って送信したい内容のJSONを用意し、文字列として渡してください。
例：
{"title":"サンプルタイトル","category": ["サンプルカテゴリ"]}任意の文字列を指定してください。
（例："テキスト1"）
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
HTML文字列を用いることで装飾や画像を指定できます。詳しくはリッチエディタのWRITE APIをご覧ください。
（例："<h1>見出し</h1><p>このようにHTMLで入稿できます</p>"）
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
HTMLタグを付与した状態での登録は非対応となります。
※HTMLを登録した場合、以下のようにエスケープされます。<p>テキスト1</p> → ＆lt;p＆gt;テキスト1＆lt;/p＆gt;
microCMSの同じサービスにアップロードされた画像のURLを指定してください。
（例："https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample.png" ）
メディアのカスタムドメインが設定されている場合、カスタムドメインとデフォルトのドメイン（microcms-assets.io）の両方を受け付けられます。
また、以下のように不正なURLを指定した場合はエラーになります。
microCMSの同じサービスにアップロードされた画像のURLを配列で指定してください。
（例：["https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample1.png", "https://images.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/sample2.png"]）
指定可能な画像URLについては、画像フィールドと同様です。
ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2020-04-23T14:32:38.163Z"）
数字を指定してください。
（例：123）
真偽値を指定してください。
（例：true）
セレクトフィールドの要素を配列で指定してください。
（例：["要素1","要素2"]）
参照先コンテンツのcontentIdを指定してください。
（例："参照先id"）
参照先コンテンツのcontentIdを配列で指定してください。
（例：["参照先id1","参照先id2"]）
対象となるデータをオブジェクト形式で指定してください。fieldIdとフィールドの値を含めてください。
（例：{ "fieldId": "YOUR_FIELD_ID", "some_value": "" }）
対象となるデータをカスタムフィールドの配列で指定してください。配列の各要素には、fieldIdとフィールドの値を含めてください。
例：
[
{
"fieldId": "YOURFIRSTFIELDID",
"sometext_value": ""
},
{
"fieldId": "YOUR_SECOND_FIELD_ID",
"some_int_value": 10
}
]microCMSの同じサービスにアップロードされたメディアのURLを指定してください。
（例："https://files.microcms-assets.io/assets/xxxxxxxx/yyyyyyyy/manual.pdf" ）
メディアのカスタムドメインが設定されている場合、カスタムドメインとデフォルトのドメイン（microcms-assets.io）の両方を受け付けられます。
また、以下のように不正なURLを指定した場合はエラーになります。
対象となるデータ内容（message部分）をオブジェクト形式で指定してください。登録したいプロパティのみを指定できます。
各値の詳細については、拡張フィールドをご確認ください。
例：
{
"id": "some-id",
"title": "some-title",
"description": "some-description",
"imageUrl": "https://images.microcms-assets.io/assets/xxxx/yyyy/{fileName}.png",
"updatedAt": "2024-01-01T00:00:00Z",
"data": { "id": "123" }
}ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2024-01-01T00:00:00Z"）
POST APIにおいてフィールドの値を空値で登録したい場合、リクエストボディに当該フィールドのキーを含めずにリクエストしてください。
正常にコンテンツを作成できた場合は201レスポンスが返却されます。
リクエストを正常に実行できた場合のレスポンスボディは以下のようになります。
{
"id": "someId"
}コンテンツAPIのエラーレスポンスを参照ください。