Endpoint settings

API endpoints can be added and updated in the API page.
In order for clients to access Kuroco's data, endpoints need to be set up to manipulate the target resource.

This section describes the configurations for endpoints.

Creating an endpoint

Click [Configure Endpoint] to create a new endpoint.

Configure Endpoint dialog

Item	Description
Path	The first part, /rcms_api/xxx/, cannot be changed. `/rcms_api/{api_id}/` is the fixed format. In general, you should name the path according to your usage, such as model + behavior. Example: `login`, `content/news`, `member/insert`
Model	A detailed description of each category/model/operation is provided in [List of categories configurable by endpoint](#List of categories configurable by endpoint). Values such as "v1" in the pull-down next to the model name indicate the version of each API model.
Summary	Please provide a summary of the API. The summary will be displayed in the endpoint list/Swagger UI.
Description	Please provide a detailed description of the API, including how to use it, if necessary. The CommonMark notation can be used here. The description will be displayed in each endpoint of the Swagger UI screen.
Authentication	There are 3 types of authentication to choose from: None/GroupAuth/MemberCustomSearchAuth. If GroupAuth or MemberCustomSearchAuth is selected, the permissions of the logged-in user will be checked when using the API, and the request will be allowed only if they match.
Cache	Set the period of time to cache the API response in seconds. Kuroco charges a fee on a pay-as-you-use basis, so it is recommended that you set this if you are using a media site or other application where a large number of requests are expected. We recommend a cache period of 1 day, 1 week, etc. The cache will be automatically cleared when is updated.

List of categories that can be set for endpoints.

This section explains the category list.

Authentication

Model	Operation	Description
Login	login_challenge	Login
	token	Get access token
	logout	Logout
	reminder	Send password reset email / reset password (Used if users forgot their current password)
	reset_password	change password (use if you remember your current password)
	profile	Get login user information
	gcs_info	Get information about GCS (Cloud Storage for Firebase) integrated with the site
	firebaseToken	Get the authentication token of Firebase integrated with the site.

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
TopicsCategory	list	Get category list
TopicsGroup	list	Get content definition list
	details	Get content definition details

Member

Model	Operation	Description
Member	list	Get member list
	details	Get member details
	invite	Invite a member
	insert	Add new member
	update	Update member
	delete	Delete member
	bulk_upsert	Add/update members in bulk
MemberCustomSearch	list	Get member custom search condition list
	details	Get member custom search condition details
	insert	Add new member custom search condition
	update	Update member custom search condition
	delete	Delete member custom search condition
	identify	Get custom search condition that matches the member information
MemberForm	details	Get member item settings details
MemberGroup	list	Get group list

Activity

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

Favorite

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

Inquiry

Model	Operation	Description
InquiryMessage	list	Get inquiry response list
	details	Get inquiry response details
	send	Send inquiry response
	update	Update inquiry response
	delete	Delete inquiry response
	InquiryForm	list
	details	Get item information of each form
	insert	Add new item information for each form
	update	Update item information for each form
	delete	Delete item information for each form
	report	Get the response report of each form

Notification

Model	Operation	Description
Magazine	send	Send notification

E-commerce

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

Files

Model	Operation	Description
Files	upload	Upload files

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

Tables

Model	Operation	Description
Master	list	Get contents of table (master)
	insert	Add new table (master)
	update	Update table (master)
	delete	Delete table (master)

Asynchronous processing

Model	Operation	Description
Batch	webhook	Call a batch process
	list	Get batch process list
	check_batch	Get batch process status

API

Model	Operation	Description
Api	bulk	Batch API endpoint execution
	list	Get API list
	openapi_data	Get openapi.json of API
	request_api	Execute the API created by the original process (GET method)
	request_api_post	Execute the API created by the original process (POST method)
	add_site	Add new Kuroco site

Workflow

|Model |Operation |Description | | :--- | :--- | :--- | :--- | |Approvalflow|review|Approval or rejection of pending data for approval workflow| ||list_pending|Get a list of pending data for approval workflow| ||pending_detail|Get a detail of pending data for approval workflow|