エンドポイント 設定項目一覧

API画面では、APIエンドポイントの追加/更新を行うことができます。
クライアントがKurocoのデータにアクセスするには、対象のリソースを操作するためのエンドポイントを設定する必要があります。

ここでは、エンドポイントの設定項目について説明します。

エンドポイントの作成画面

[Configure Endpoint]をクリックすると、エンドポイントを新規作成することができます。

Image (fetched from Gyazo)

基本設定画面

項目説明
パス先頭の /rcms_api/xxx/ の部分は変更不可です。/rcms_api/{api_id}/の形式で固定値が設定されます。
基本的にはモデル+動作など、使用方法に応じたパスを命名してください。
例: login, content/news, member/insert
モデル各カテゴリ/モデル/オペレーションの詳細な説明は、エンドポイントで設定可能なカテゴリー一覧に記載します。
モデル名の横に表示しているプルダウンの「v1」等の値は、各APIモデルのバージョン名を示します。
サマリーAPIの概要を記載してください。
記載した内容はエンドポイント一覧/Swagger UIに表示されます。
ディスクリプション必要に応じてAPIの使用方法など、詳細な説明を記載してください。
ここではCommonMarkの記法を利用することができます。
記述した内容は、Swagger UI画面の各エンドポイントにも表示されます。
認証下記3種類より選択できます。
- None
- GroupAuth
- MemberCustomSearchAuth
GroupAuthもしくはMemberCustomSearchAuthを選択すると、APIの使用時にログインユーザの権限をチェックし、合致した場合にのみリクエストを許可します。
キャッシュAPIレスポンスをキャッシュする期間を秒単位で設定します。
Kurocoでは従量課金で費用がかかるため、メディアサイトなど多量のリクエストが見込まれる用途でご利用される場合は、設定することを推奨します。
キャッシュ期間は1日・1週間等をお勧めしております。
コンテンツ・メンバー等、取得対象のデータに更新があった場合、キャッシュは自動的にクリアされます。

エンドポイントで設定可能なカテゴリー一覧

カテゴリー一覧を説明します。

Image (fetched from Gyazo)

認証

モデルオペレーション説明
Loginlogin_challengeログイン
tokenアクセストークンの取得
logoutログアウト
reminderパスワード再設定メールの送信・パスワードの再設定
(現在のパスワードを忘れた場合に利用)
reset_passwordパスワードの変更
(現在のパスワードを覚えている場合に利用)
profileログインユーザの情報を取得
gcs_infoサイトと連携したGCS(Cloud Storage for Firebase)の情報を取得
firebaseTokenサイトと連携したFirebaseの認証トークンを取得

コンテンツ

モデルオペレーション説明
Topicslistコンテンツ一覧の取得
detailsコンテンツ詳細の取得
previewコンテンツのプレビューを取得
insertコンテンツの新規追加
updateコンテンツの更新
deleteコンテンツの削除
TopicsCategorylistカテゴリ一覧の取得
TopicsGrouplistコンテンツ定義の一覧を取得
detailsコンテンツ定義の詳細を取得

メンバー

モデルオペレーション説明
Memberlistメンバー一覧の取得
detailsメンバー詳細の取得
inviteメンバーの招待
insertメンバーの新規追加
updateメンバーの更新
deleteメンバーの削除
bulk_upsertメンバーの一括追加・更新
MemberCustomSearchlistメンバーカスタム検索条件の一覧を取得
detailsメンバーカスタム検索条件の詳細を取得
insertメンバーカスタム検索条件の新規追加
updateメンバーカスタム検索条件の更新
deleteメンバーカスタム検索条件の削除
identifyメンバー情報に合致するカスタム検索条件の取得
MemberFormdetailsメンバー項目設定の詳細を取得
MemberGrouplistグループの一覧を取得

アクティビティ

モデルオペレーション説明
Commentlistコメント一覧の取得
insertコメントの新規追加
updateコメントの更新
deleteコメントの削除

お気に入り

モデルオペレーション説明
Favoritelistお気に入り一覧の取得
insertお気に入りの新規追加
deleteお気に入りの削除

フォーム

モデルオペレーション説明
InquiryMessagelistフォーム回答済み情報の一覧を取得
detailsフォーム回答情報の詳細を取得
sendフォーム回答情報を送信
updateフォーム回答情報を更新
deleteフォーム回答情報を削除
InquiryFormlistフォーム情報の一覧を取得
details各フォームの項目情報を取得
insert各フォームの項目情報を新規追加
update各フォームの項目情報を更新
delete各フォームの項目情報を削除
report各フォームの回答レポートを取得

配信

モデルオペレーション説明
Magazinesend配信の送信

EC

モデルオペレーション説明
ECCartdetailsカート詳細を取得
addカートに商品を追加
updateカート内の商品を更新
ECPaymentlist支払い方法の一覧を取得
details支払い方法の詳細を取得
ECOderSubscriptionlist継続注文情報の一覧を取得
details継続注文情報の詳細を取得
insert継続注文情報を追加
ECDeliverylist配送情報の一覧を取得
details配送情報の詳細を取得
ECShoplistショップ一覧を取得
detailsショップ詳細を取得
ECProductlist商品一覧を取得
details商品詳細を取得
ECOrderlist注文情報の一覧を取得
details注文情報の詳細を取得
total注文の総計を取得
purchase商品の購入
cancel注文のキャンセル
insert注文情報の新規追加

ファイル

モデルオペレーション説明
Filesuploadファイルのアップロード

タグ

モデルオペレーション説明
Taglistタグ一覧の取得
insertタグの新規追加
deleteタグの削除
TagCategorylistタグカテゴリ一覧の取得

テーブル

モデルオペレーション説明
Masterlistテーブル(マスタ)の内容を取得
insertテーブル(マスタ)の新規追加
updateテーブル(マスタ)の更新
deleteテーブル(マスタ)の削除

非同期タスク

モデルオペレーション説明
Batchwebhookバッチ処理の呼び出し
listバッチ処理の一覧を取得
check_batchバッチ処理のステータスを取得

API

モデルオペレーション説明
ApibulkAPIエンドポイントの一括実行
listAPI一覧の取得
openapi_dataAPIのopenapi.jsonを取得
request_apiオリジナル処理で作成したAPIの実行 (GETメソッド)
request_api_postオリジナル処理で作成したAPIの実行 (POSTメソッド)
add_siteKurocoサイトの新規追加

承認ワークフロー

モデルオペレーション説明
Approvalflowreview承認ワークフロー申請中データの承認・差し戻し
list_pending承認ワークフロー申請中データの一覧を取得
pending_detail承認ワークフロー申請中データの詳細を取得