Endpoints

Fireapis provides you different endpoints pre-created at the time of table creation which will more sufficient for most common use cases.

Endpoint will give you request url and information about how to use those, most of the business usecase can be solved with those APIs, but in case if you need more complicated busines logics then you can refer logics section.

Endpoint section

The above image shows the different endpoints which below you can find more details about each endpoint.

Here's different endpoint details

{{table}} represent your actual table name, {{environmentName}} represent your actual environment name

POST Create a new record in {{table}}

This endpoint is POST type endpoint which will be useful for adding a record into your table using endpoint which will be used in nocode ui builder or else in any frontend client application.

In this PK(Primary Key) column by default will be disable as it will be created by fireapis by default as unique value.

Disabled primary key column

You can find the implentation of this endpoint by using generared cURL. Here the list of configuration,

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}

Data or Body - JSON which is given in this endpoint section

For all above details, Refer below images:

[POST] Create a new record in table.

GET Get record in {{table}} by id

This endpoint is GET type endpoint which will be useful for getting a record using their primary key which is id by default in fireapis.

Here the list of configurations

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body - There is no input data required for GET request method.

__id__ represent the primary key value of an record, for eg: you want to fetch id of 2 from your table.

For all above details, Refer below images:

Get a record from {{table}} by id

PUT - Update record in {{table}} by id

This endpoint is PUT type endpoint which will be useful for updating a record using their primary key which is id by default in fireapis.

Here the list of configurations

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body - JSON which is given in this endpoint section

__id__ represent the primary key value of an record, for eg: you want to fetch id of 2 from your table.

For all above details, Refer below images:

Update a record in {{table}} by id

DELETE - Delete a record in {{table}} by id

This endpoint is DELETE type endpoint which will be useful for deleting a record using their primary key which is id by default in fireapis.

Here the list of configurations

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}/__id__

Data or Body - There is no input data required for DELETE request method.

__id__ represent the primary key value of an record, for eg: you want to fetch id of 2 from your table.

Deleting a record will premanently deletes the record, so be aware of this action.

For all above details, Refer below images:

Delete a record in {{table}} by id

GET - Get all records in {{table}}

This endpoint is GET type endpoint which will be useful for getting all the records with paginated by default in that particular table

Here the list of configurations

Header - Refers common header for every end point request

URL - https://{{environmentName}}.fireapis.com/{{table}}/all?page=1&take=10

Data or Body - There is no input data required for GET request method.

Query Params - ?page=1&take=10 in URL represent query parameters. 1. page - The page number for the request data 2. take - Number of records to be listed on each page So for eg: ?page=2&take20 means get the second page 20 list of items

This endpoint will always have pagination by default in order to optimise ther performance

For all above details, Refer below images:

Get all record in {{table}}

We have convered all the ednpoints in detail and their usage.