Endpoint settings

You can add and update API endpoints on the API screen.
In order for clients to access Kuroco data, you need to set up endpoints that can modify the target resource.

This document describes the details of endpoint configurations.

Creating an endpoint

On the endpoint list screen, click [Configure endpoint] to open the endpoint configuration dialog.

Item	Description
Path	Follows the fixed format of: /rcms_api/{api_id}/. The first part of the path, /rcms_api/xxx/, cannot be changed. In general, you should name the path based on how the endpoint is used, such as based on "model + behavior". For example, login, content/news, member/insert.
Model	See: Model categories for a detailed description of each category/model/operation. Values such as "v1" in the dropdown menu next to the model type indicate the version of each endpoint model.
Summary	Overview of the API. This information will be displayed on the endpoint list/Swagger UI screen.
Description	Detailed description of the API, including how to use it, if necessary. This information will be displayed on each endpoint on the Swagger UI screen. The CommonMark notation can be used here.
Authentication	Authentication types: None GroupAuth MemberCustomSearchAuth If "GroupAuth" or "MemberCustomSearchAuth" is selected, the authorization of the logged-in user will be checked when using the API, and the request will be allowed only if the user has matching authorization.
Cache	The cache period of the API response in seconds. The cache will be automatically cleared when there is an update to the data to be retrieved, such as contents or members. (Note: Since Kuroco is a pay-per-use service, we recommended that you configure the cache for media sites or other applications where a large number of requests are expected. We recommend a cache period of 1 day, 1 week, etc.)
Rate limit	Set the number of requests allowed within a maximum of 3600 seconds. If the limit is exceeded, a '429 Too Many Requests' response will be generated. Information on the rate limit status is contained in the following parts of the response header: Limit number: x-rcms-ratelimit-limit Remaining number of possible requests: x-rcms-ratelimit-remaining Remaining time until reset: x-rcms-ratelimit-reset

Model categories

This section explains the category list for the "Model" field.

Authentication

Model	Operation	Description
Login	login_challenge	Login
	login_challenge_mfa	Authenticate with MFA one-time password (second step of two-factor authentication)
	token	Get access token
	file_access_token	Get a file access token
	alias_login	Login using an alias ID
	logout	Logout
	reminder	Send password reset e-mail / resets password (when the user has forgotten their current password)
	reset_password	Change current password (when the user remembers their current password)
	profile	Get login user information
	gcs_info	Get information about the site-integrated GCS (Cloud Storage for Firebase)
	firebaseToken	Get the authentication token of the site-integrated Firebase
LoginHistory	list	Get login history
LoginFailedRelease version: β / RCversion	list	Get login failure history list
TwofactorMethod	reserve	Generate a secret key for two-factor authentication (provisional registration)
	regist	Confirm two-factor authentication registration
	reminder	Send a reset code for two-factor authentication
	reset	Reset two-factor authentication settings
	delete	Delete two-factor authentication settings

Content

Model	Operation	Description
Topics	list	Get content list
	details	Get content details
	preview	Get a preview of the content
	insert	Add new content
	update	Update content
	delete	Delete content
	draft_list	Get draft list
	draft_details	Get draft details
	draft_save	Add new draft
	draft_delete	Delete draft
	draft_update	Update draft
	waiting_for_approval_list	Get the list of contents that are pending for approval
	waiting_for_approval_details	Get details of the content that is pending for approval
	history_list	Get content change history list
	accept	Approve content
	reject	Reject content
	bulk_upsert	Update content in bulk
	bulk_download	Download content in bulk
	increment	Increase or decrease the value of "counter" field(s) in the content
TopicsCategory	list	Get category list
TopicsGroup	list	Get content structure list
	details	Get content structure details
	insertRelease version: β / RCversion	Add new content structure

Member

Model	Operation	Description
MemberProvisional	list	Get pre-member list
	insert	Add new pending member
	update	Update pending member
	delete	Delete pending member
Member	list	Get member list
	details	Get member details
	invite	Invite a member
	insert	Add new member
	update	Update current member
	delete	Delete current member
	bulk_upsert	Add/update members in bulk
MemberCustomSearch	list	Get custom member filter list
	details	Get custom member filter details
	insert	Add new custom member filter
	update	Update custom member filter
	delete	Delete custom member filter
	identify	Get custom member filter that match the member information
MemberForm	details	Get member field settings details
MemberGroup	list	Get group list

Activity

Model	Operation	Description
Comment	list	Get activity list
	insert	Add new activity
	update	Update activity
	delete	Delete activity

Favorite

Model	Operation	Description
Favorite	list	Get favorite list
	insert	Add new favorite
	delete	Delete favorite

Form

Model	Operation	Description
InquiryMessage	list	Get form response list
	details	Get form response details
	send	Send form response
	update	Update form response
	delete	Delete form response
	bulk_upsert	Update form response in bulk
InquiryForm	list	Get form list
	details	Get form details
	insert	Add new form
	update	Update form
	delete	Delete form
	report	Get form report data

Notification

Model	Operation	Description
MagazineInfo	list	Get notification list
MagazineSubscriber	list	Get subscriber list
	subscribe	Subscribe to notification
	unsubscribe	Unsubscribe from notification
Magazine	send	Send notification
	delete	Delete message
	subscribe	Subscribe to notification *The usage of Magazine::subscribe has been deprecated. It is recommended to use MagazineSubscriber::subscribe with self_only or required_key parameters instead.
	unsubscribe	Unsubscribe from notification *The usage of Magazine::unsubscribe has been deprecated. It is recommended to use MagazineSubscriber::unsubscribe with self_only or required_key parameters instead.
	list	Get message list

E-commerce

Model	Operation	Description
ECOrderSubscription	list	Get subscription order list
	details	Get subscription order details
	insert	Add subscription order
	auth_sp_career	Authenticate carrier payment user
ECOrder	list	Get order list
	details	Get order details
	total	Get order totals
	purchase	Purchase goods
	cancel	Cancel order
	insert	Add new order information
	auth_sp_career	Authenticate carrier payment user
ECDelivery	list	Get delivery list
	details	Get delivery details
ECCart	details	Get cart details
	add	Add products to cart
	update	Update products in cart
ECShop	list	Get shop list
	details	Get shop details
ECProduct	list	Get product list
	details	Get product details
ECPayment	list	Get payment method list
	details	Get payment method details

Files

Model	Operation	Description
Files	upload	Upload files
	temp_upload_urlRelease version: β / RCversion	Get a temporary URL for uploading files directly to S3 via HTTP PUT

Tags

Model	Operation	Description
Tag	list	Get tag list
	insert	Add new tag
	update	Update a tag
	delete	Delete tag
TagCategory	list	Get tag category list

Table

Model	Operation	Description
Master	list	Get master list
	insert	Add new master
	update	Update master
	delete	Delete master

Batch process

Model	Operation	Description
Batch	webhook	Execute the batch process
	list	Get batch process list
	check_batch	Get batch process status

API

Model	Operation	Description
Api	bulk	Execute multiple API endpoint
	list	Get API list
	openapi_data	Get the API openapi.json
	request_api	Execute custom function via API (GET method)
	request_api_post	Execute custom function via API (POST method)
	proxy	Proxies requests and responses. (GET method)
	proxy_post	Proxies requests and responses. (POST method)
	aggregate	Proxy multiple requests and responses. Responses are integrated and returned. (GET method)
	add_site	Add new Kuroco site
	site_list	Kuroco site list
	sso_credentials	Provides the authentication credentials for SSO between Kuroco sites.

API ManagementRelease version: β / RCversion

Model	Operation	Description
ApiManagement	insert	Add new API
	update	Update API

Workflow

Model	Operation	Description
Approvalflow	list	Get approval workflow list
	details	Get approval workflow details
	insert	Add approval workflow
	update	Update approval workflow basic settings
	update_flow_settings	Update approval workflow flow settings
	delete	Delete approval workflow
	review	Approve or reject approval workflow data for the specified module type Supported module types Content *The usage of Approvalflow::review has been deprecated. Instead, it is recommended to use Topics::accept/reject.
	list_pending	Get approval workflow data list for the specified module type Supported module types Content *The usage of Approvalflow::list_pending has been deprecated. Instead, it is recommended to use Topics::waiting_for_approval_list.
	pending_detail	Get approval workflow data details for the specified module type Supported module types Content *The usage of Approvalflow::pending_detail has been deprecated. Instead, it is recommended to use Topics::waiting_for_approval_details.

Payments

Model	Operation	Description
Stripe	checkout	Generate subscription payment URL
	cancel_order	Cancel subscription

Site

Model	Operation	Description
Site	update_site	Update site settings
	list	Get site list
	create_backup	Create a site backup
	get_backup_list	Get backup list
	generate_backup_download_url	Generate download URL for a backup
	delete_backup	Delete a backup
	get_env_edit_data	Get site configuration details
	add_site	Add new Kuroco site
	update_env_info	Update site configuration
	close_sites	Close multiple sites in bulk
	sync_sites	Sync multiple sites in bulk
	backup_sites	Create backups for multiple sites in bulk
	sync_topics	Sync content between sites
	get_mng_data	Get management settings
	update_mng	Update management settings

Kuroco FrontRelease version: β / RCversion

Model	Operation	Description
KurocoFront	deploy	Deploy to Kuroco Front from an artifact URL

AI

Model	Operation	Description
OpenAI	chat	Generate answers using OpenAI. Requires AI to be enabled in the site settings.
	rag_search	Search content using RAG and generate answers using OpenAI. Requires AI to be enabled in the site settings. The target content structure must also have RAG (embedding model) enabled.
	chat_contents_search	Generate answers using OpenAI by referencing registered content. Requires AI to be enabled in the site settings. The target content structure must also have RAG (embedding model) enabled.
	routing_rules	Get AI router routing rules configuration. Requires AI to be enabled in the site settings.

Spider

Model	Operation	Description
SpiderHistory	list	Get web crawler execution history list. The Spider feature is available when AI is enabled in the site settings.
	details	Get web crawler execution details
	logs	Get logs of web crawler execution
Spider	insert	Create a new web crawler configuration
	update	Update an existing web crawler configuration
	webhook	Execute web crawler process

Custom processingRelease version: β / RCversion

Model	Operation	Description
CustomProcessing	list	Get custom processing list
	details	Get custom processing details
	insert	Add new custom processing
	update	Update custom processing
	delete	Delete custom processing
	validate	Validate and test-execute custom processing

Integrations

Model	Operation	Description
EmailRelease version: β / RCversion	send	Send an email
LineRelease version: β / RCversion	send	Send a LINE message. Requires LINE integration to be enabled in the site settings.
TeamsRelease version: β / RCversion	send	Send a message to Microsoft Teams. Requires Microsoft Teams integration to be enabled in the site settings.
SlackRelease version: β / RCversion	send	Send a message to Slack. Requires Slack integration to be enabled in the site settings.
	get	Get a Slack message. Requires Slack integration to be enabled in the site settings.
EdgeIntegration	process	Process edge integration data
	list	Get edge integration list
	details	Get edge integration details