Authentication

The vast majority of API endpoints within the Appmixer require an access token to execute the calls. The following methods explain how to create a user and obtain the access token through the sign-in endpoint.

Sign-in User

POST https://api.appmixer.com/user/auth

Sign-in a user with credentials and get their access token. curl -XPOST "https://api.appmixer.com/user/auth" -H "Content-type: application/json" -d '{ "username": "[e-mail]", "password": "abc321" }' You can sign in either with your username and password or with your email and password

Request Body

Name	Type	Description
password*	string	Password.
username	string	Username. If the email is not provided in the body, a username is required. Hence, a username or email must be included.
email	string	Email. If the username is not provided in the body, an email is required. Hence, a username or email must be included.

200

{
    "user": {
        "id": "5c88c7cc04a917256c726c3d",
        "username":"[e-mail]",
        "isActive": false,
        "email": "[e-mail]", 
        "plan":"free",
        "vendor": null
    },
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkyNjA5LCJleHAiOjE1NTUwODQ2MDl9.9jVcqY0qo9Q_1GeK9Fg14v7OrdpWvzmqnv4jDMZfqnI"
}

Create User

POST https://api.appmixer.com/user

Create user. By default, this endpoint is open (does not require authentication). This can be changed by setting the API_USER_CREATE_SCOPE system configuration. If you set the value of API_USER_CREATE_SCOPE to for example admin, then an admin token will be required to call this API. curl -XPOST "https://api.appmixer.com/user" -H "Content-type: application/json" -d '{ "username": "[e-mail]", "email": "[e-mail]", "password": "abc321" }'

Request Body

Name	Type	Description
password*	string	Password.
email*	string	Email address.
username*	string	Username.

200

{
    "token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVjODhjN2NjMDRhOTE3MjU2YzcyNmMzZCIsInNjb3BlIjpbInVzZXIiXSwiaWF0IjoxNTUyNDkyNjA5LCJleHAiOjE1NTUwODQ2MDl9.9jVcqY0qo9Q_1GeK9Fg14v7OrdpWvzmqnv4jDMZfqnI"
    "user": {
        "id": "65699f8de6f980000739e6e0",
        "username": "abc",
        "isActive": false,
        "email": "[e-mail]",
        "plan": "free",
        "vendor": null
    }
}

Get User Information

GET https://api.appmixer.com/user

Get user information. curl "https://api.appmixer.com/user" -H "Authorization: Bearer [ACCESS_TOKEN]"

200

{
  "id": "58593f07c3ee4f239dc69ff7",
  "username": "[e-mail]",
  "isActive": true,
  "email": "[e-mail]",
  "scope": [
    "user"
  ],
  "plan": "beta"
}