Mini App Center - API Reference

The Mini App Center provides an API designed to facilitate interaction with the data from Mini Apps, Super Apps, Organizations, or any other information provided by the Mini App Center.

Generic Variables

Notice the following properties needed when using the API.

Authentication

In order to use the API, you need to authenticate each request using API Tokens. These tokens are managed in the Mini App Center Backoffice and uniquely identify the sender of the request.

To authenticate your requests, you need to provide your token via Header ("APIKey-Auth"). 

For security purposes, it is strongly recommended that you do not share your API tokens with anyone and revoke them immediately if they are compromised.

Errors

REST API employs the widely accepted practice of using HTTP response codes to convey the status of an API request. The codes in the 2xx range indicate that the request was successful and the server has returned the expected data. On the other hand, the codes in the 4xx range indicate that the request failed because of a client-side error, such as missing or invalid parameters, unauthorized access, or any other fault in the request.

The codes in the 5xx range suggest that there's an error on the server side, and the request couldn't be completed due to a server malfunction or connectivity issue. Such errors, fortunately, are infrequent in the service.

By following these HTTP response codes, users can easily understand whether their API requests have succeeded or failed, and the probable causes of failure if there are any.

If there is an error during the execution, all APIs return a list of errors and a status code 400*:

{
  "errors": [
    {
      "code": "integer",
      "message": "string"
    },
    ...
  ]
}

Versioning

The API versioning strategy is designed to minimize disruptions to your application when backwards-incompatible changes are introduced.

Whenever changes are made to the API, a new version is released. This approach allows you to continue using the previous version of the API until you are ready to upgrade to the latest version.

It is strongly recommended that you always specify the version number when making API requests to ensure the correct behavior of your application. You can find the latest version number in the documentation or by contacting the support team.

By using versioning, you ensure that your application remains stable and functional while providing access to the latest API features and functionality.