POST /api/v1/{endpoint}
最終更新日: 2020/04/24
POST APIを用いることで、コンテンツの入稿をAPI経由で行うことができます。
プランによってPOST APIのリクエスト上限数は異なります。
リクエストヘッダー
X-WRITE-API-KEY
POST, PUT, PATCH, DELETE APIリクエストの際に必要な認証キーです。
リクエストヘッダーに含めて送信してください。
未使用の場合は削除しておくことを推奨します。
InformationAPI-KEY / WRITE-API-KEYはサービス内の全API共通となります。
そのため、クライアントサイドから直接APIを呼び出すことでユーザーがキーを把握できてしまう場合、エンドポイントさえ分かれば他のAPIも呼び出せてしまうことにご注意ください。
対処法としては、サーバサイドからAPIを呼び出す、またはJamstack構成にするなどしてキーを漏洩しないことが挙げられます。
Content-Type
送信するデータの形式を指定します。
microCMSではJSON形式のデータのみ扱っているため、application/jsonと指定してください。
リクエストボディ
APIスキーマに沿って送信したい内容のJSONを用意し、文字列として渡してください。
例：
{"title":"bodyサンプル","publishedAt":"2020-04-23T14:32:38.163Z"}各フィールドにおける値の指定方法は下記の通りです。
テキストフィールド
任意の文字列を指定してください。
（例："テキスト1"）
テキストエリア、リッチエディタ
改行コードを用いることで複数行の文字列を指定できます。
（例："複数行のテキストを入力\n複数行のテキストを入力"）
画像、ファイル、カスタムフィールド、繰り返しフィールド
非対応です。指定しても空になります。
日時
ISO 形式 (ISO 8601) の文字列で指定してください。
（例："2020-04-23T14:32:38.163Z"）
数字
数字を指定してください。
（例：123）
真偽値
真偽値を指定してください。
（例：true）
コンテンツ参照
参照先コンテンツのcontentIdを指定してください。
（例："参照先id"）
コンテンツ複数参照
参照先コンテンツのcontentIdを配列で指定してください。
（例：["参照先id1","参照先id2"]）