Authentication
Last updated
Last updated
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.
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": "abc@example.com", "password": "abc321" }'
You can sign in either with your username and password or with your email and password
| Name | Type | Description |
|---|---|---|
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": "abc@example.com", "email": "abc@example.com", "password": "abc321" }'
GET https://api.appmixer.com/user
Get user information.
curl "https://api.appmixer.com/user" -H "Authorization: Bearer [ACCESS_TOKEN]"
| 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.
string
Email. If the username is not provided in the body, an email is required. Hence, a username or email must be included.
password*
string
Password.
email*
string
Email address.
username*
string
Username.