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

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

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

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

[新しいエンドポイントの追加]をクリックすると、エンドポイントを新規作成できます。

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

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

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

認証

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

コンテンツ

モデル	オペレーション	説明
Topics	list	コンテンツ一覧の取得
	details	コンテンツ詳細の取得
	preview	コンテンツのプレビューを取得
	insert	コンテンツの新規追加
	update	コンテンツの更新
	delete	コンテンツの削除
	draft_list	途中保存一覧の取得
	draft_details	途中保存詳細の取得
	draft_save	途中保存の新規追加
	draft_delete	途中保存の削除
	draft_update	途中保存の更新
	waiting_for_approval_list	承認ワークフロー申請中データの一覧を取得
	waiting_for_approval_details	承認ワークフロー申請中データの詳細を取得
	accept	コンテンツのワークフローの承認
	reject	コンテンツのワークフローの差し戻し
	bulk_upsert	コンテンツをバッチで更新
	bulk_download	コンテンツをバッチでダウンロード
	increment	コンテンツに設定したカウンターの項目の値を増減
TopicsCategory	list	カテゴリ一覧の取得
TopicsGroup	list	コンテンツ定義の一覧を取得
	details	コンテンツ定義の詳細を取得

メンバー

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

アクティビティ

モデル	オペレーション	説明
Comment	list	アクティビティ一覧の取得
	insert	アクティビティの新規追加
	update	アクティビティの更新
	delete	アクティビティの削除

お気に入り

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

フォーム

モデル	オペレーション	説明
InquiryMessage	list	フォーム回答済み情報の一覧を取得
	details	フォーム回答情報の詳細を取得
	send	フォーム回答情報を送信
	update	フォーム回答情報を更新
	delete	フォーム回答情報を削除
	bulk_upsert	フォーム回答をバッチで更新
InquiryForm	list	フォーム一覧の取得
	details	フォームの詳細を取得
	insert	フォームの新規追加
	update	フォームの更新
	delete	フォームの削除
	report	フォームの回答レポートを取得

配信

モデル	オペレーション	説明
MagazineInfo	list	配信一覧の取得
MagazineSubscriber	list	配信購読者一覧の取得
	subscribe	購読者の登録
	unsubscribe	購読者の削除
Magazine	send	配信の送信
	delete	配信メッセージを削除
	subscribe	購読者の登録 ※Magazine::subscribe の使用は非推奨になります。代わりに、self_only パラメータまたは required_key パラメータを設定した MagazineSubscriber::subscribe を使用することを推奨します。
	unsubscribe	購読者の削除 ※Magazine::unsubscribe の使用は非推奨になります。代わりに、self_only パラメータまたは required_key パラメータを設定した MagazineSubscriber::unsubscribe を使用することを推奨します。
	list	配信メッセージ一覧の取得

EC

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

ファイル

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

タグ

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

テーブル

モデル	オペレーション	説明
Master	list	マスタ一覧の取得
	insert	マスタの新規追加
	update	マスタの更新
	delete	マスタの削除

バッチ処理

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

API

モデル	オペレーション	説明
Api	bulk	APIエンドポイントの一括実行
	list	API一覧の取得
	openapi_data	APIのopenapi.jsonを取得
	request_api	カスタム処理で作成したAPIの実行 (GETメソッド)
	request_api_post	カスタム処理で作成したAPIの実行 (POSTメソッド)
	proxy	リクエストとレスポンスをプロキシ (GETメソッド)
	proxy_post	リクエストとレスポンスをプロキシ (POSTメソッド)
	aggregate	複数のリクエストとレスポンスをプロキシする。レスポンスは統合されて返される(GETメソッド)
	add_site	Kurocoサイトの新規追加
	site_list	Kurocoサイト一覧
	sso_credentials	Kuroco site間でのSSOに必要な認証情報を提供します

承認ワークフロー

モデル	オペレーション	説明
Approvalflow	list	承認ワークフロー一覧の取得
	details	承認ワークフロー詳細の取得
	insert	承認ワークフローの追加
	update	承認ワークフロー基本設定の更新
	update_flow_settings	承認ワークフローフロー設定の更新
	delete	承認ワークフローの削除
	review	指定したモジュールタイプの承認ワークフロー申請中データの承認・差し戻し 対応中のモジュールタイプは以下 コンテンツ ※Approvalflow::review の使用は非推奨になります。代わりに、Topics::accept/reject を使用することを推奨します。
	list_pending	指定したモジュールタイプの承認ワークフロー申請中データの一覧を取得 対応中のモジュールタイプは以下 コンテンツ ※Approvalflow::list_pending の使用は非推奨になります。代わりに、Topics::waiting_for_approval_list を使用することを推奨します。
	pending_detail	指定したモジュールタイプの承認ワークフロー申請中データの詳細を取得 対応中のモジュールタイプは以下 コンテンツ ※Approvalflow::pending_detail の使用は非推奨になります。代わりに、Topics::waiting_for_approval_details を使用することを推奨します。

Payments

モデル	オペレーション	説明
Stripe	checkout	サブスクリプションの支払いURL作成
	cancel_order	サブスクリプションの解除

AI

モデル	オペレーション	説明
OprnAI	chat	OpenAIによる回答の生成
	chat_contents_search	登録されたコンテンツを参照して、OpenAIによる回答を生成

Spider

モデル	オペレーション	説明
SpiderHistory	list	WEBクローラー実行履歴一覧の取得
	details	WEBクローラー実行詳細の取得
	logs	WEBクローラー実行ログの取得
Spider	insert	WEBクローラー設定の新規作成
	update	WEBクローラー設定の更新
	webhook	WEBクローラー処理の実行