API tokens allow external applications, integrations, and custom software to securely access your SimplifyAccess account through the User API.
An API token acts as a personal access credential and is linked directly to your user account. Applications can use this token to authenticate requests without requiring your account password.
Generating an API Token
- Sign in to your SimplifyAccess account.
- Open the Account page.
- Navigate to the Security section.
- Locate the API Access area.
- Click Generate API Key.
After generation, the token is displayed once. Copy and store it in a secure location before closing the page.
Regenerating an API Token
If you need to replace an existing token:
- Open the Account page.
- Navigate to Security.
- Click Regenerate API Key.
The previous token immediately becomes invalid and can no longer be used.
Revoking an API Token
To permanently disable API access:
- Open the Account page.
- Navigate to Security.
- Click Revoke API Key.
All future API requests using the revoked token will be rejected.
Security Recommendations
- Treat API tokens like passwords.
- Never share tokens publicly.
- Never embed tokens in frontend JavaScript.
- Store tokens in secure environment variables or configuration files.
- Revoke tokens immediately if they are exposed or compromised.
Authentication Example
All User API requests use Bearer Authentication.
Example request:
curl -X GET \https://admin.simplify-access.com/api/v1/me \-H "Authorization: Bearer YOUR_API_TOKEN" \-H "Accept: application/json"
Testing Your API Token
The easiest way to verify that your token works is to call the /me endpoint.
Example:
curl -X GET \https://admin.simplify-access.com/api/v1/me \-H "Authorization: Bearer YOUR_API_TOKEN" \-H "Accept: application/json"
Example response:
{
"data": {
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"language": "en",
}
}
A successful response confirms that your token is valid and can be used to access the User API.
Next Steps
Once your API token is working, continue with the User API guide to learn how to retrieve controllers, access settings, and update widget configurations through the API.
