ドキュメント

API設定

プロジェクト内のAPIの設定変更方法や削除方法をご説明します。

管理画面のAPI一覧より、任意のAPIの画面を開いた状態で「API設定」から、API設定画面へ遷移します。

API基本設定

API基本設定にて、「API名」「エンドポイント」を設定・変更できます。エンドポイントはAPIの最後尾のパスにあたる文字列です。以下の入力条件に従って入力してください。

  • 3文字以上32文字以内
  • 半角英数字
  • 小文字のみ
  • 記号はハイフン、アンダースコアのみ
  • すでに設定済みのAPIエンドポイントとの重複不可

APIスキーマ

APIのレスポンス構造を設定することができます。 各フィールドのフィールドタイプの詳細は「APIスキーマのフィールドタイプ」のページをご確認ください。

コンテンツプレビュー

作成したコンテンツのプレビュー設定を行うことができます。詳細は「コンテンツプレビュー」のページをご確認ください。

HTTPメソッド

該当のAPIで有効にするHTTPメソッド(POST / PATCH / DELETE)を選択することができます。詳細は「HTTPメソッド」のページをご確認ください。

Webhook

APIのコンテンツを更新した際、Webhook通知を行うことができます。詳細は「Webhook」のページをご確認ください。

APIの削除

「削除」メニューからAPIの削除を行うことができます。一度削除したAPIは復元出来ませんので、ご注意ください。

まずは無料でお試しください

メールアドレスのみで簡単に登録できます。
データ設計と運用を簡単に行えるhacoCMSの機能を是非ご覧ください。