microCMS

API経由でコンテンツの追加・編集・削除ができるようになりました

更新情報
2020/08/31 松田 承一

ウォンタ株式会社の松田です。
本日の更新情報をお知らせします。

PUT, PATCH, DELETE APIが追加されました

これまで、REST形式であるコンテンツAPIにはGETとPOSTのみが用意されていました。
本日よりこの2つに加え、以下の機能を追加いたしました。

  • PUT:コンテンツの新規追加
  • PATCH:コンテンツの編集
  • DELETE:コンテンツの削除

PUT

PUT /api/v1/{endpoint}/{content_id}

コンテンツを新規に追加します。
URLにはコンテンツのidを含める必要があり、このidを持ったコンテンツが生成されます。
(POSTの場合はidの指定はできません)
また、リクエストのボディ部には作成するコンテンツの内容を含めてください。

PATCH

※リスト形式
PATCH /api/v1/{endpoint}/{content_id}

※オブジェクト形式
PATCH /api/v1/{endpoint}

コンテンツを編集します。
リクエストのボディ部にはコンテンツの編集したい部分の内容を含めてください。

DELETE

DELETE /api/v1/{endpoint}/{content_id}

コンテンツを削除します

以上がそれぞれの簡単なインタフェース説明となりますが、詳しくは管理画面内の「APIリファレンス」やドキュメントサイトをご参照ください。
また、全てのAPIは「APIプレビュー」から動作を確認できますのでこちらも合わせてご利用ください。

事前に必要な準備と注意点

PUT / PATCH / DELETEそれぞれのAPIを利用するには準備が必要です。
POST機能のリリース記事でも解説している以下2つについては、今回も同じように事前に準備をしてください。

  1. X-WRITE-API-KEYの生成
  2. HTTPメソッドで有効にするメソッドを選択


また、今回ご紹介したAPIはご利用プランによって利用回数に制限があります。
詳しくは料金ページをご参照ください。

おわりに

今回新たに導入されたPUT / PATCH / DELETEを使うことで、これまで以上に柔軟にコンテンツを外部からコントロールすることが可能になりました。
既存システムとの連携や、社内DBとのデータ同期など、様々な用途にお役立てください!

ABOUT ME

松田 承一
ウォンタ株式会社の代表 / 家族=👨‍👩‍👧 / ヤフー→大学教員など→現職 / 管理画面付きAPIがすぐに作れるmicroCMSというサービス作ってます。

microCMSとは

  1. 開発者、編集者どちらも分かりやすい管理画面

  2. 細かな権限管理や豊富な外部サービス・データ連携

  3. 安心の日本製・日本語でのチャットサポート