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. Image from Gyazo

Configure Endpoint dialog

ItemDescription
PathThe 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
ModelA 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.
SummaryPlease provide a summary of the API.
The summary will be displayed in the endpoint list/Swagger UI.
DescriptionPlease 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.
AuthenticationThere 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.
CacheSet 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.

Image from Gyazo

Authentication

ModelOperationDescription
Loginlogin_challengeLogin
tokenGet access token
logoutLogout
reminderSend password reset email / reset password
(Used if users forgot their current password)
reset_passwordchange password
(use if you remember your current password)
profileGet login user information
gcs_infoGet information about GCS (Cloud Storage for Firebase) integrated with the site
firebaseTokenGet the authentication token of Firebase integrated with the site.

Content

ModelOperationDescription
TopicslistGet content list
detailsGet content details
previewGet a preview of the content
insertAdd new content
updateUpdate content
deleteDelete content
TopicsCategorylistGet category list
TopicsGrouplistGet content definition list
detailsGet content definition details

Member

ModelOperationDescription
MemberlistGet member list
detailsGet member details
inviteInvite a member
insertAdd new member
updateUpdate member
deleteDelete member
bulk_upsertAdd/update members in bulk
MemberCustomSearchlistGet member custom search condition list
detailsGet member custom search condition details
insertAdd new member custom search condition
updateUpdate member custom search condition
deleteDelete member custom search condition
identifyGet custom search condition that matches the member information
MemberFormdetailsGet member item settings details
MemberGrouplistGet group list

Activity

ModelOperationDescription
CommentlistGet comment list
insertAdd new comment
updateUpdate comment
deleteDelete comment

Favorite

ModelOperationDescription
FavoritelistGet favorite list
insertAdd new favorite
deleteDelete favorite

Inquiry

ModelOperationDescription
InquiryMessagelistGet inquiry response list
detailsGet inquiry response details
sendSend inquiry response
updateUpdate inquiry response
deleteDelete inquiry response
InquiryFormlist
detailsGet item information of each form
insertAdd new item information for each form
updateUpdate item information for each form
deleteDelete item information for each form
reportGet the response report of each form

Notification

ModelOperationDescription
MagazinesendSend notification

E-commerce

ModelOperationDescription
ECCartdetailsGet cart details
addAdd products to cart
updateUpdate products in cart
ECPaymentlist
detailsGet payment method details
ECOderSubscriptionlist
detailsGet subscription order details
insertAdd subscription order
ECDeliverylist
detailsGet delivery details
ECShoplistGet shop list
detailsGet shop details
ECProductlistGet product list
detailsGet product details
ECOrderlistGet order list
detailsGet order details
totalGet order totals
purchasePurchase goods
cancelCancel order
insertAdd new order information

Files

ModelOperationDescription
FilesuploadUpload files

Tags

ModelOperationDescription
TaglistGet tag list
insertAdd new tag
deleteDelete tag
TagCategorylistGet tag category list

Tables

ModelOperationDescription
MasterlistGet contents of table (master)
insertAdd new table (master)
updateUpdate table (master)
deleteDelete table (master)

Asynchronous processing

ModelOperationDescription
BatchwebhookCall a batch process
listGet batch process list
check_batchGet batch process status

API

ModelOperationDescription
ApibulkBatch API endpoint execution
listGet API list
openapi_dataGet openapi.json of API
request_apiExecute the API created by the original process (GET method)
request_api_postExecute the API created by the original process (POST method)
add_siteAdd 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|