API documentation

The use of this API is restricted to programmers and people with advanced technological knowledge. Any feature that you want to perform through the API can also be performed through the web interface, so if you don't have technological knowledge, please use the web interface.

The auth token is required to authenticate yourself to our API. Please note that you will only see this information if you are logged into the site and that this data is unique to your account and not personal, do not share it with anyone outside your company. The information to be included in all calls is:

You must be logged in to see these values Enter here.

Our API is REST format, so it is independent from the language to be used. Calls are always made via through following endpoint:

https://acumbamail.com/api/1/(nombreFuncion)/

This endpoint will receive the input parameters. Our recommendation, given that in most cases modifications will be made to the data stored in the database, is to use POST, although we also have the capacity to support GET requests.

All functions, in addition to the specific data that they return in response to the request, will also return a html status code that we can enter. There is an specific code for each situation, which are the following:

• Status code

• 200

  Query successfully completed

• 201

  Data successfully modified

• 400

  Request failed: some invalid argument

• 401

  Unauthorised, the authentication process has failed

• 429

  Too many requests to an operation in a period of time

• 500

  A server error has occurred. Please contact us to fix it

In some cases, a dictionary is requested as an input parameter for the methods. For POST operations all parameters must be contained in the body as form-data, in order to code a dictionary in GET operation an example might be:

https://acumbamail.com/api/1/(nombreFuncion)/?dict[key]=value&dict[key1]=value1&dict[key2]=value2

This endpoint will receive the input parameters. Our recommendation, given that in most cases modifications will be made to the data stored in the database, is to use POST, although we also have the capacity to support GET requests.