エンドポイント 設定項目一覧
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種類より選択できます。
|
| キャッシュ | APIレスポンスをキャッシュする期間を秒単位で設定します。 Kurocoでは従量課金で費用がかかるため、メディアサイトなど多量のリクエストが見込まれる用途でご利用される場合は、設定することを推奨します。 キャッシュ期間は1日・1週間等をお勧めしております。 コンテンツ・メンバー等、取得対象のデータに更新があった場合、キャッシュは自動的にクリアされます。 |
| Stale-While-Revalidate | APIのキャッシュにstale-while-revalidate（秒）を付与します。高頻度のアクセスがあるAPIの場合に設定すると、APIパフォーマンス向上に効果があります。（例: 86400） キャッシュ期間を設定している場合に表示されます。 |
| Stale-If-Error | APIのキャッシュ再取得中にエラーが発生した場合、エラーを出力する代わりに古いレスポンスを返す期限（秒）を設定できます。（例: 600） キャッシュ期間を設定している場合に表示されます。 |
| キャッシュ単位 | [グループの組み合わせ単位でキャッシュする]を有効にすると、キャッシュの単位を「ログインセッション単位」から「リクエスト会員の所属グループの組み合わせ単位」に切り替えます。同じグループ構成の会員間でCDNキャッシュを共有でき、ヒット率が向上します。 この設定はキャッシュ期間を設定している場合に有効です。 以下の条件をすべて満たすエンドポイントでのみ表示されます。
|
| 流量制限 | 最大3600秒内で許可するリクエスト数をセットできます。制限を超えた場合は 429 Too Many Requests をレスポンスします。 流量制限の状況はレスポンスヘッダーで確認可能です。
|
エンドポイントで設定可能なカテゴリー一覧
カテゴリー一覧を説明します。
ログイン
認証
| モデル | オペレーション | 説明 |
|---|---|---|
| Login | login_challenge | ログイン |
| login_challenge_mfa | 2要素認証（MFA）のワンタイムパスワードでのログイン | |
| token | アクセストークンの取得 | |
| file_access_token | ファイルアクセス用のアクセストークンを取得 | |
| alias_login | エイリアスIDを使ったログイン | |
| logout | ログアウト | |
| reminder | パスワード再設定メールの送信・パスワードの再設定 (現在のパスワードを忘れた場合に利用) | |
| reset_password | パスワードの変更 (現在のパスワードを覚えている場合に利用) | |
| profile | ログインユーザーの情報を取得 | |
| gcs_info | サイトと連携したGCS(Cloud Storage for Firebase)の情報を取得 | |
| firebaseToken | サイトと連携したFirebaseの認証トークンを取得 | |
| LoginHistory | list | ログイン履歴を取得 |
| LoginFailed | list | ログイン失敗履歴の一覧を取得 |
| TwofactorMethod | reserve | 2要素認証用のシークレットキーを生成（仮登録） |
| regist | 2要素認証の登録を確定 | |
| reminder | 2要素認証のリセット用コードを送信 | |
| reset | 2要素認証の設定をリセット | |
| delete | 2要素認証の設定を削除 |
コンテンツ
コンテンツ
| モデル | オペレーション | 説明 |
|---|---|---|
| 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 | 承認ワークフロー申請中データの詳細を取得 | |
| history_list | コンテンツの変更履歴一覧を取得 | |
| accept | コンテンツのワークフローの承認 | |
| reject | コンテンツのワークフローの差し戻し | |
| bulk_upsert | コンテンツをバッチで更新 | |
| bulk_download | コンテンツをバッチでダウンロード | |
| increment | コンテンツに設定したカウンターの項目の値を増減 | |
| TopicsCategory | list | カテゴリ一覧の取得 |
| TopicsGroup | list | コンテンツ定義の一覧を取得 |
| details | コンテンツ定義の詳細を取得 | |
| insert | コンテンツ定義の新規追加 |
テーブル
| モデル | オペレーション | 説明 |
|---|---|---|
| Master | list | マスタ一覧の取得 |
| insert | マスタの新規追加 | |
| update | マスタの更新 | |
| delete | マスタの削除 |
タグ
| モデル | オペレーション | 説明 |
|---|---|---|
| Tag | list | タグ一覧の取得 |
| insert | タグの新規追加 | |
| update | タグの更新 | |
| delete | タグの削除 | |
| TagCategory | list | タグカテゴリ一覧の取得 |
ファイル
| モデル | オペレーション | 説明 |
|---|---|---|
| Files | upload | ファイルのアップロード |
| temp_upload_url | HTTP PUTでファイルを直接S3にアップロードするための一時URLを取得 | |
| FileManager | upload | ファイルマネージャーへのファイルのアップロード |
| delete | ファイルマネージャーのファイルまたはディレクトリの削除 | |
| list | ファイルマネージャーのファイルおよびディレクトリ一覧の取得 |
API
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に必要な認証情報を提供します |
API管理
| モデル | オペレーション | 説明 |
|---|---|---|
| ApiManagement | insert | APIの新規追加 |
| update | APIの更新 |
AI
AI
| モデル | オペレーション | 説明 |
|---|---|---|
| OpenAI | chat | OpenAIによる回答の生成。サイト設定でAI機能を有効にする必要があります。 |
| rag_search | RAGを使ってコンテンツを検索し、OpenAIによる回答を生成。サイト設定でAI機能を有効にする必要があります。また、対象のコンテンツ構造でRAG（埋め込みモデル）が有効になっている必要があります。 | |
| chat_contents_search | 登録されたコンテンツを参照して、OpenAIによる回答を生成。サイト設定でAI機能を有効にする必要があります。また、対象のコンテンツ構造でRAG（埋め込みモデル）が有効になっている必要があります。 | |
| routing_rules | AIルーターのルーティングルール設定を取得。サイト設定でAI機能を有効にする必要があります。 | |
| AiAgent | create_session | AIエージェントのセッションを作成。ai_agent_id で対象のAIエージェントを指定します。事前にAIエージェントの作成が必要です。 |
| send_message | AIエージェントのセッションにメッセージを送信。create_session で取得した ai_session_id と message を指定します。セッションが処理中の場合は400が返るため、時間をおいて再試行してください。 |
チャネル
WEB
| モデル | オペレーション | 説明 |
|---|---|---|
| InquiryMessage | list | フォーム回答済み情報の一覧を取得 |
| details | フォーム回答情報の詳細を取得 | |
| send | フォーム回答情報を送信 | |
| update | フォーム回答情報を更新 | |
| delete | フォーム回答情報を削除 | |
| bulk_upsert | フォーム回答をバッチで更新 | |
| InquiryForm | list | フォーム一覧の取得 |
| details | フォームの詳細を取得 | |
| insert | フォームの新規追加 | |
| update | フォームの更新 | |
| delete | フォームの削除 | |
| report | フォームの回答レポートを取得 | |
| KurocoFront | deploy | アーティファクトURLからKuroco Frontへデプロイ |
| SpiderHistory | list | WEBクローラー実行履歴一覧の取得。Spider機能はサイト設定でAI機能を有効にすると利用可能になります。 |
| details | WEBクローラー実行詳細の取得 | |
| logs | WEBクローラー実行ログの取得 | |
| Spider | insert | WEBクローラー設定の新規作成 |
| update | WEBクローラー設定の更新 | |
| webhook | WEBクローラー処理の実行 |
メール
| モデル | オペレーション | 説明 |
|---|---|---|
| send | メールの送信 |
メッセージング
| モデル | オペレーション | 説明 |
|---|---|---|
| Line | send | LINEメッセージの送信。サイト設定でLINE連携を有効にする必要があります。 |
| Teams | send | Microsoft Teamsへのメッセージ送信。サイト設定でMicrosoft Teams連携を有効にする必要があります。 |
| Slack | send | Slackへのメッセージ送信。サイト設定でSlack連携を有効にする必要があります。 |
| get | Slackのメッセージを取得。サイト設定でSlack連携を有効にする必要があります。 |
一括配信
| モデル | オペレーション | 説明 |
|---|---|---|
| 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 | 配信メッセージ一覧の取得 |
アクティビティ
アクティビティ
| モデル | オペレーション | 説明 |
|---|---|---|
| Comment | list | アクティビティ一覧の取得 |
| insert | アクティビティの新規追加 | |
| update | アクティビティの更新 | |
| delete | アクティビティの削除 |
お気に入り
| モデル | オペレーション | 説明 |
|---|---|---|
| Favorite | list | お気に入り一覧の取得 |
| insert | お気に入りの新規追加 | |
| delete | お気に入りの削除 |
メンバー管理
メンバー
| モデル | オペレーション | 説明 |
|---|---|---|
| Member | list | メンバー一覧の取得 |
| details | メンバー詳細の取得 | |
| invite | メンバーの招待 | |
| insert | メンバーの新規追加 | |
| update | メンバーの更新 | |
| delete | メンバーの削除 | |
| bulk_upsert | メンバーの一括追加・更新 | |
| MemberProvisional | list | 仮メンバー一覧の取得 |
| insert | 仮メンバー一覧の新規追加 | |
| update | 仮メンバー一覧の更新 | |
| delete | 仮メンバー一覧の削除 | |
| MemberCustomSearch | list | メンバーカスタム検索条件の一覧を取得 |
| details | メンバーカスタム検索条件の詳細を取得 | |
| insert | メンバーカスタム検索条件の新規追加 | |
| update | メンバーカスタム検索条件の更新 | |
| delete | メンバーカスタム検索条件の削除 | |
| identify | メンバー情報に合致するカスタム検索条件の取得 | |
| MemberForm | details | メンバー項目設定の詳細を取得 |
| MemberGroup | list | グループの一覧を取得 |
オペレーション
非同期タスク
| モデル | オペレーション | 説明 |
|---|---|---|
| Batch | webhook | バッチ処理の呼び出し |
| list | バッチ処理一覧の取得 | |
| check_batch | バッチ処理ステータスの取得 |
承認ワークフロー
| モデル | オペレーション | 説明 |
|---|---|---|
| Approvalflow | list | 承認ワークフロー一覧の取得 |
| details | 承認ワークフロー詳細の取得 | |
| insert | 承認ワークフローの追加 | |
| update | 承認ワークフロー基本設定の更新 | |
| update_flow_settings | 承認ワークフローフロー設定の更新 | |
| delete | 承認ワークフローの削除 | |
| review | 指定したモジュールタイプの承認ワークフロー申請中データの承認・差し戻し 対応中のモジュールタイプは以下
| |
| list_pending | 指定したモジュールタイプの承認ワークフロー申請中データの一覧を取得 対応中のモジュールタイプは以下
| |
| pending_detail | 指定したモジュールタイプの承認ワークフロー申請中データの詳細を取得 対応中のモジュールタイプは以下
|
カスタム処理
| モデル | オペレーション | 説明 |
|---|---|---|
| CustomProcessing | list | カスタム処理一覧の取得 |
| details | カスタム処理の詳細を取得 | |
| insert | カスタム処理の新規追加 | |
| update | カスタム処理の更新 | |
| delete | カスタム処理の削除 | |
| validate | カスタム処理のバリデーションとテスト実行 |
EC
EC
| モデル | オペレーション | 説明 |
|---|---|---|
| ECOrderSubscription | list | 継続注文情報の一覧を取得 |
| details | 継続注文情報の詳細を取得 | |
| insert | 継続注文情報を追加 | |
| auth_sp_career | キャリア決済のユーザー認証 | |
| ECOrder | list | 注文情報の一覧を取得 |
| details | 注文情報の詳細を取得 | |
| total | 注文の総計を取得 | |
| purchase | 商品の購入 | |
| cancel | 注文のキャンセル | |
| insert | 注文情報の新規追加 | |
| auth_sp_career | キャリア決済のユーザー認証 | |
| ECDelivery | list | 配送情報の一覧を取得 |
| details | 配送情報の詳細を取得 | |
| ECCart | details | カート詳細を取得 |
| add | カートに商品を追加 | |
| update | カート内の商品を更新 | |
| ECShop | list | ショップ一覧を取得 |
| details | ショップ詳細を取得 | |
| ECProduct | list | 商品一覧を取得 |
| details | 商品詳細を取得 | |
| ECPayment | list | 支払い方法の一覧を取得 |
| details | 支払い方法の詳細を取得 | |
| ECPoint | update | メンバーのポイントを更新（付与・消費） 参考：ECポイントの仕様とポイント更新・履歴取得API |
| history | メンバーのポイント履歴と残高を取得 参考：ECポイントの仕様とポイント更新・履歴取得API |
Payments
| モデル | オペレーション | 説明 |
|---|---|---|
| Stripe | checkout | サブスクリプションの支払いURL作成 |
| cancel_order | サブスクリプションの解除 |
環境設定
Site
| モデル | オペレーション | 説明 |
|---|---|---|
| Site | update_site | サイト設定の更新 |
| list | サイト一覧の取得 | |
| create_backup | バックアップの作成 | |
| get_backup_list | バックアップ一覧の取得 | |
| generate_backup_download_url | バックアップのダウンロードURLを生成 | |
| delete_backup | バックアップの削除 | |
| get_env_edit_data | サイト設定の詳細を取得 | |
| add_site | Kurocoサイトの新規追加 | |
| update_env_info | サイト設定情報の更新 | |
| close_sites | 複数サイトを一括クローズ | |
| sync_sites | 複数サイトを一括同期 | |
| backup_sites | 複数サイトを一括バックアップ | |
| sync_topics | サイト間でコンテンツを同期 | |
| get_mng_data | 管理設定情報の取得 | |
| update_mng | 管理設定情報の更新 |
関連ドキュメント
サポート
お探しのページは見つかりましたか？解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。