The API (Application Programming Interface) offers third-party applications a way to connect to and interact with Blesta. This section describes how to create and manage API users. For technical documentation on using the API, see the API section of the Developer Manual.

Creating API Users

API users can be created by visiting [Settings] > [System] > [API Access], then clicking the Add API User button. Each API user must have a unique username within its assigned company. The company assignment designates which company the API user will be authenticated with when connecting. This allows the API user to perform actions within the context of the assigned company. When the API user is added an API key is randomly generated.

API users are system level users

API users may access data belonging to other companies in the system using API requests that support such access.

Managing API Users

A complete list of API users is available in [Settings] > [System] > [API Access]. An unlimited number of API users may be created. For enhanced security, it's recommended to create a separate user for each connecting application.

When an API user is deleted API requests will no longer be accepted with those credentials. For security reasons Blesta does not allow API keys to be entered when creating a user. If an API user is mistakenly deleted a new user must be created (which may contain the same username as the previously deleted account) and the connecting application must be updated with the new credentials.

  • No labels