This document presents the API for the Adtoma Fusion system. The documentation, as well as the API itself, are in early beta stage, and are a subject to change. For each method that is not yet implemented a “!! “Prefix is added in front of Method.
Adtoma Fusion API may be referred simply as API from now on.
Metrics of document is available in chapter: Appendix A. , at the bottom of document.
General API information
Protocol and style
Adtoma Fusion API is a classic REST style API, accessible using HTTP protocol.
The data format used for transferring objects to and from the API can be either JSON or XML (set in the accept header of the HTTP request).
The response can be compressed, when you add header ‘Accept-Encoding’ into request with value ‘gzip’ or ‘deflate’. We support both compressing methods gzip and deflate.
We log responses and requests in files on server site. For method GET we log only request. You can log response as well, but you have to add “debug=true” into queryString.
The request to the API is authorized by a client authentication token, known also as an API key. Each client application needs an authentication token, which is used to identify the request. The authentication token is a sensitive piece of information, and shall be treated the same way as passwords.
The authentication token is passed to the API in a request header:
Adtoma Fusion API is a stateless service, and it applies also to the user authentication mechanisms – i.e., no session is created for a request. As such, API does not provide functions for user authentication; instead, each request must contain username and password in order to access the resources. It is a responsibility of the client application to cache this information to not force end users to enter username and password at each API request.
Authentication mechanism is a Basic Authentication, and security is maintained by using an SSL communication channel.
Access to certain methods or certain data is dependent on the access rights assigned to a user. This aspect of the API usage is quite broad and is not covered in this document. For further information, please contact Adtoma AB.
API Description (Objects and Methods)
This section describes the objects that are passed to or returned from the API, and methods of the API that operate on those objects.
This section is divided into subsections, grouping the described objects and methods into relevant areas. The methods with exclamation marks prefix are not implemented yet.
After applying for access to the API, you’ll be given a single “admin” user that will have rights to create and update additional users that can use the system.
A user is an object describing a single, actual user that has access to the API. Access to objects and methods of the API is defined on a user level, so it’s important that every person that is going to have access to the API has its own user object representing her in the system. Property
|id||number||The Adtoma Fusion ID of the user|
|username||string||The user name. Usually, this is an e-mail, but the API does not restrict it.|
|password||string||The password of the user. This field is never filled in by the API, and is only used to send password to the system.|
|person||Person||The person object associated with this user; can be undefined.|
|teams||Team||An array of the teams the user belongs to; can be undefined.|