API

Overview

This API provides a way for multiple tenants to access their own data. The API allows tenants to dynamically pull data from specific tables based on their requirements.

Base URL

http://api.nexify-it.com/api/<tenantId>

Replace:

• <tenantId>: The unique identifier for the tenant that is accessing the API. This can be found in your tenant administration panel.

Authentication

Before making any requests to the API, tenants must authenticate themselves using a token.

Generating a Token

A API token can be generated under the following path.

Administration Panel / API / New Token

Accessing Data

Once you have obtained a token, you can access data from specific tables using GET requests.

Fetching Data from a Table

Endpoint:

GET /api/<tenantId>/data/<tableName>

Request Headers:

• Authorization: Bearer token obtained from administration panel

Query Parameters: (optional)

• filterField: The field name you want to filter by.
• filterValue: The value of the field to filter against.

Example Request to Access Data

To fetch data from a table named users:

curl -X GET "https://api.nexify-it.com/api/00000-00000-00/data/users" \
-H "Authorization: Bearer your-api-token"

Example Response

The response will include the selected fields from the specified table:

[
    {
        "id": 1,
        "name": "John Doe",
        "email": "[email protected]"
    },
    {
        "id": 2,
        "name": "Jane Smith",
        "email": "[email protected]"
    }
]

Filtering Data

You can filter the data returned by specifying query parameters:

Example Request with Filters:

To fetch users with a specific email:

curl -X GET "Https://api.nexify-it.com/api/00000-00000-00/data/[email protected]" \
-H "Authorization: Bearer your-api-token"

Example Response with Filters

[
    {
        "id": 1,
        "name": "John Doe",
        "email": "[email protected]"
    }
]

Conclusion

This API provides a secure and efficient way for tenants to access their data. By using your API token for authentication and allowing dynamic querying of the database.

If you have any questions or require further assistance, please contact our support team.