Access Appmixer REST API

Appmixer offers a REST API that mirrors the functionalities accessible through its UI. This API enables advanced customizations, additional automations, and scripting capabilities for enhanced integration flexibility.

The base URL for the Appmixer REST API varies according to your specific Appmixer tenant. Throughout this documentation, it is referred to as [TENANT_API_URL]. Replace it with the API URL of your tenant, for example:

• https://api-acme.appmixer.ai for newer hosted tenants,
• https://api.acme.appmixer.cloud for older hosted tenants,
• the API URL of your own installation in case of a Self-Managed Appmixer.

Similarly, [TENANT_STUDIO_URL] refers to the URL of your Appmixer Studio, for example https://acme.appmixer.ai or https://my.acme.appmixer.cloud, and [TENANT_BACKOFFICE_URL] to the URL of your Appmixer Backoffice, for example https://backoffice-acme.appmixer.ai or https://backoffice.acme.appmixer.cloud.

The majority of the Appmixer API endpoints require authentication using an access token associated with an Appmixer user account. Certain endpoints may require that this user to has the admin scope; specific requirements are detailed at each endpoint's documentation. To obtain a user's access token, sign in using the user's credentials:

$ curl -XPOST "[TENANT_API_URL]/user/auth" \
-H "Content-type: application/json" \
-d '{ "username": "[e-mail]", "password": "abc321" }'

On success, Appmixer returns a JSON object structured as follows:

{
    "user": {
        "id": "5c88c7cc04a917256c726c3d",
        "username":"[e-mail]",
        "email": "[e-mail]"
    },
    "token":"eyJhbGciOiJIUzI1NiIsInR5cC..."
}

Use the token in the Authorization header to authenticate your user to the Appmixer API. For example:

$ curl "[TENANT_API_URL]/flows" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cC..."

Find the full documentation to the REST API here.

OpenAPI Specification

The REST API is also described by an OpenAPI 3.1 specification. Import it into tools such as Postman, Insomnia or Swagger UI to explore the API, generate API clients in your programming language, or give AI agents a machine-readable description of the API. Set the tenantApiUrl server variable to your [TENANT_API_URL].

appmixer-openapi.yaml

323KB

Open