Endpoint settings

You can add and update API endpoints on the API screen. Setting up endpoints allows you to manipulate the target resources for clients to access Kuroco's data.

This section describes endpoint configurations in detail.

Creating an endpoint

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

fetched from Gyazo

Configure Endpoint dialog

ItemDescription
PathFollows the fixed format of: /rcms_api/{api_id}/. The first part of the part, /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.
ModelSee: 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 API model.
SummaryOverview of the API. This information will be displayed on the endpoint list/Swagger UI screen.
DescriptionDetailed description of the API, including how to use it, if necessary. This information will be displayed for each endpoint on the Swagger UI screen.
The CommonMark notation can be used here.
AuthenticationSelect the type of authentication:
  • None
  • GroupAuth
  • MemberCustomSearchAuth
If "GroupAuth" or "MemberCustomSearchAuth" is selected, the logged-in user is subject to a permission check when using the API, and the request will be allowed only if there is a match.
CacheThe cache period of the API response in seconds. The cache will be automatically cleared when the retrieved data (such as contents or members) is updated.
(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.)

Model categories

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

Image (fetched from Gyazo)

Authentication

ModelOperationDescription
Loginlogin_challengeLogin
tokenGet access token
logoutLogout
reminderSend password reset e-mail / resets password
(when the user has forgotten their current password)
reset_passwordChange current password
(when the user remembers their current password)
profileGet login user information
gcs_infoGet information about the site-integrated GCS (Cloud Storage for Firebase)
firebaseTokenGet the authentication token of the site-integrated Firebase

Content

ModelOperationDescription
TopicslistGet content list
detailsGet content details
previewGet a preview of the content
insertAdd new content
updateUpdate current content
deleteDelete current 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 current member
deleteDelete current member
bulk_upsertAdd/update members in bulk
MemberCustomSearchlistGet member custom search condition list
detailsGet member custom search condition details
insertAdd new member custom search conditions
updateUpdate existing member custom search conditions
deleteDelete existing member custom search conditions
identifyGet custom search conditions that match the member information
MemberFormdetailsGet member item settings details
MemberGrouplistGet group list

Activity

ModelOperationDescription
CommentlistGet comment list
insertAdd new comment
updateUpdate current comment
deleteDelete current comment

Favorite

ModelOperationDescription
FavoritelistGet favorite list
insertAdd new favorite
deleteDelete current favorite

Inquiry

ModelOperationDescription
InquiryMessagelistGet inquiry response list
detailsGet inquiry response details
sendSend inquiry response
updateUpdate inquiry response
deleteDelete inquiry response
InquiryFormlist
detailsGet item information for each form
insertAdd new item information for each form
updateUpdate current item information for each form
deleteDelete current item information for each form
reportGet response report for 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 existing tag
TagCategorylistGet tag category list

Tables

ModelOperationDescription
MasterlistGet contents of table (master)
insertAdd new table (master)
updateUpdate current table (master)
deleteDelete current 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 for the 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

ModelOperationDescription
ApprovalflowreviewApprove or reject pending workflow data
list_pendingGet a list of pending workflow data
pending_detailGet details of pending workflow data

If you have any other questions, please use our contact form or Slack workspace.