Getting Started

Database

Modules

API Endpoints

Mobile Editor

Web Editor

Localizations

Organization & Team

Export

Figma Import

Advance configure

Email Authentication

Phone authentication

Full project tutorial

Project overview

Create project

Configure database

Configure modules

Configure API endpoints

Import from Figma

Configure using Editor

Export and running

Release Notes

Release Notes

ようこそ、JITERAへ！

What is API endpoints?

API Endpoints are a kind of gateway that connects the server processes of the application to the front-end (web or mobile application itself). Each endpoint will be associated with its table.

Every endpoint has route/URL, method (GET, POST, PUT or DELETE), model function, request parameters and response parameters.

Prerequisite

Created at least one table (see Table configuration)

View endpoints

To view API endpoints, go to API endpoints menu. By default, the existing endpoint groups that are generated from your database tables will appear on the left pane.

Clicking on an endpoint group on the left pane will open the endpoints list on the right pane.

Enable or disable API endpoint

On the endpoints list, toggle the status of an endpoint to “ON” to enable that endpoint.

To disable the endpoint, toggle the status back to “OFF”.

There are five pre-configuration endpoints in the endpoint list that can be enabled and configured. Example below for table users:

• GET — /api/users
• POST — /api/users
• PUT — /api/users/:id
• GET — /api/users/:id
• DELETE — /api/users/:id

Configure and delete API endpoint

To configure the API endpoint, click “edit” icon.

The configuration panel will appear immediately on the right side

To delete the endpoint, click “delete” icon near the “edit” icon

Configure HTTP method and URL

To configure HTTP request method, select the HTTP method in the select box.

To configure URL request, specify the request url to the url input

HTTP method options:

• GET — The GET ****request is commonly used for retrieving/reading data from a server, it doesn't allow any modification of resources present on the server
• POST — The POST request is used for sending data to the server in order to create or update a resource. JSON format is usually used for sending the data to the server
• PUT — The PUT request is used for updating an existing resource present on the server. If the resource that is to be updated is not present, then the API may create the resource on the server
• DELETE — The DELETE request is used for deleting any data present on the server.

Configure request params

To refine the request params for the endpoint, fill in the name and datatype option

• Data Type Options:

You can also enter the JSON request parameter by click “auto-fill” link and fill the json object that you want as request params to text area field

Configure model function

GET method with search action

To configure the filter function of GET model function, there are three areas that can be configured

1. General
2. Condition table
3. Pagination and ordering

General

Input fields

• Name — Name of the model function
• Model — (disable) Auto selected according to the selected table on the left submenu
• Action (disable) Auto selected according to the pre-configuration endpoints (GET, POST, PUT, GET, DELETE)

Condition table

The table is used for filter the list of table record that match with the configured conditions

Column definition

• Condition — There are two options which are AND and OR operators that used for filtering records based on one or more than condition
  • The AND operator displays a record if all the conditions separated by AND are TRUE
  • The OR operator displays a record if any of the conditions separated by OR is TRUE
• Column definition — The column of table that uses for filtering the record
• Query — The query that use for filtering the record, the options are base on the column type of column definition that selected (see the list query option)
• Value — The value of request params that configured per step configure request params

Query option

• String, Text
  • End With — Returns the records if the target column value end with request value
  • Start With — Returns the records if the target column value start with the request value
  • Between Characters — Returns the records if the request value is in between the target column value
• Integer, Float, Date, Datetime
  • Equal to — Returns the records if the target column value is equal to the request value
  • Not Equal to — Returns the records if the target column value is not equal to the request value
  • Greater then — Returns the records if the target column value is greater than the request value
  • Less Then — Returns the records if the target column value is less then the request value
• File
  • Equal — Returns the records if the target column value is equal to the request value
• Enum
  • Equal to — Returns the records if the target column value is equal to the request value
  • Not Equal to — Returns the records if the target column value is not equal to the request value

To delete a condition, click “Trash” button, the condition row will disappear in the condition table

Pagination and ordering

Pagination and ordering of the table record result

Input fields

• Page — Number of page of table record result
• Limit — Limit of table record result per page
• Order by — Sort table record base on selected table column
• Order — Sort table record base on option below
  • Asc — sort table record in ascending order
  • Desc — sort table record in descending order

GET method with show action

To configure the show function of GET model function, there are two areas that can be configured

1. General
2. Condition table

General

The configuration can be configured the same as General configuration of the GET model function with show action configuration

Condition table

The table is used for selecting only one the record that match with the configured condition

Google Analytics module