This document describes how to configure, connect to, and interact with the API. For information on expanding the API with your own custom code see Extending the API. All examples are presented using PHP.
|Table of Contents|
Before you begin using the API you must first create a set of API credentials for the company you wish to connect to. For information on creating API credentials consult the System > API Access section of the User Manual.
The structure of an API request involves specifying the model, method, and format to be requested, along with any additional parameters the method may require. For example:
In the above example, yourdomain.com is your domain and installpath is the path to the Blesta installation. If your server does not support .htaccess include index.php in your URL (e.g. /installpath/index.php/api/users/get.json?user_id=1). users is the model to request, get is the method, and json is the format.
Requesting Models of Plugins
To request a specific model of a plugin format your request as /plugin.model/method.format
The API supports XML, JSON, and PHP serialization formats. By default JSON formatting is used. So if there is an error detecting the format of the request (due to a bad URL, for example) the error response will be returned in JSON format.
There are several types of errors that may be encountered when working with the API:
Sending invalid parameters will result in a 400 Bad Request response.
Providing invalid credentials will result in a 401 Unauthorized response.
Attempting to access a resource that is not callable will result in a 403 Forbidden response.
Attempting to access a resource that does not exist will result in a 404 Not Found response.
Requesting a format that is not supported will result in a 415 Unsupported Media Type response.
If an unexpected error occurs a 500 Internal Server Error will result. If this error is encountered consult the documentation for the method you are requesting.
If an unexpected error occurs that specifies that it "Failed to retrieve the default value" then you likely encounter this issue due to IonCube in Blesta. You can work-around this issue by ensuring that you specify all optional arguments to your API call.
When Blesta is under maintenance mode, the API will return a 503 Service Unavailable response.
All error response objects contain an array of input parameters that produced errors. From the example above "field" is the parameter name. Each field may contain one or more error codes along with a related message. Common codes are empty, exists, format, length, and valid, but many more are available. The error code is always the index of the error message, and is used primarily in identifying the type of error encountered.
The API returns all timestamps in UTC time using the following ISO 8601 format:
The API expects timestamps in one of the following formats:
Always specify a timezone
If the timezone can not be determined from the timestamp, the system will assume the timestamp is in local time. For this reason you should always specify a timezone in your timestamps. For details on checking or setting the local timezone for the system check your localization settings.
Formatting dates with PHP
The easiest way to format a date into a suitable format using PHP is to use date("c").
The API supports Basic Authentication for web requests. When connecting to the API via a command line the API credentials must be passed as parameters. See Using the Command Line Interface for more information on connecting to the API via command line.
Running PHP in CGI or FCGId mode?
Update your .htaccess file to pass an environment variable to Blesta so it can capture the basic authentication details as per the following snippet:
If running PHP-FPM, set CGIPassAuth On in your .htaccess, or within your httpd.conf like the example:
There are a number of ways to connect to the API. Choose the option that best fits your environment.
To connect remotely, first determine the URL of the API for your installation. The default path is http://yourdomain.com/installpath/api/. Where yourdomain.com is the domain you've installed Blesta in, and installpath is the path to Blesta. If your server does not then the URL should instead appear as http://yourdomain.com/installpath/index.php/api/.
Because each request contains your API key, and may contain additional sensitive information, you should only process requests remotely over a secure connection (i.e. only use HTTPS)
Download the API SDK
The SDK includes an API processor that makes it super easy to work with the API.
Using the Command Line Interface
The API is available via a command line interface (CLI). The API supports the following command line parameters:
- -u or -user The API user
- -k or -key The API key
- -m or -method The method for the request (GET, POST, PUT, DELETE)
- -p or -params A URL encoded array of parameters as you would find in a URL string (e.g. first_name=John&last_name=Doe&company=Acme Co.)
Remember to quote parameters
If any of your command line parameters contain special characters or spaces you must wrap quote marks (') around the value.
Below is an example API request.
Within the Blesta environment
If you're working with or have created code within the Blesta environment, there's no need to use the API at all. All of the methods available in the API are first and foremost available to Blesta, in the form of models. To use these models, simply load the model within your environment.
The API encourages the proper use of GET, POST, PUT, and DELETE when interacting with the API. For all POST requests the API will pass only post parameters to the requested resource. For PUT only put parameters will be passed. Similarly, for all GET and DELETE requests, the API will pass only get parameters to the requested resource.
Choose the Request Type Carefully
It is highly discouraged to use GET or DELETE for API requests where you are providing sensitive information. That sensitive information will be included as plain-text as get parameters in the URI. Instead, use POST or PUT to pass that sensitive information securely in the request body rather than the URI.
Use POST requests when creating new records. For example, when adding a new user record via api/users/add.json.
Use GET requests when retrieving record data. For example, when fetching a user record via api/users/get.json.
Use PUT requests when updating records. For example, when updating a user record via api/users/edit.json.
Use DELETE requests when deleting records. For example, when deleting a user record via api/users/delete.json.
The API supports hundreds of requests, and many more through API extensions, so we can't document them all here. Instead, check out the source code documentation. All public model methods are callable through the API. To find documentation on a particular request pull up the related model and method from the source code documentation.
Below are a few basic examples to get you started.
|encryption/systemEncrypt||Encrypts the given value using 256-bit AES in CBC mode using a SHA-256 HMAC hash as the key, based on the system configured setting in Blesta.system_key|
|encryption/systemDecrypt||Decrypts the given value using 256-bit AES in CBC mode using SHA-256 HMAC hash as the key, based on the system configured setting in Blesta.system_key|
|invoices/add||Creates a new invoice using the given data|
|users/auth||Determines whether the user credentials are valid to be authenticated with Blesta|
How to Read the Source Docs
The source code documentation contains documentation on everything in Blesta, but the API only supports calling Model methods. You can find all core model methods under blesta > app > models, however plugin model methods are also callable through the API.