The accessplanit API Feeds are a great way to integrate your other systems with your accessplanit platform to streamline your operations!
Our API Feeds allow you to integrate your information with other other third party software. From employee and customer-based software such as VLE and CRM, to financial and invoicing programs, our API Feeds have the ability to automate data rekeying to save you both time and money.
Using the API Feeds for your integration
With our API Feeds module, you will have access to every available end-point, not every area of your accessplanit platform is covered by the feed so please see below to read more about what data is available through the existing API Feed endpoints.
You are able to use the RESTful API Feeds to build as many integrations with other software as you require.
To use the feeds, you will need either middleware to sit in the middle of the two systems to connect them, or a developer to connect the software together.
User API Feeds There are several endpoints available for user based information
Company Groups (account groups)
If you have built any custom fields for any of the above areas in your accessplanit platform, these are available in the feeds as read-only fields, please submit a product suggestion to let us know if there are any custom fields that you would like to be able to write-to using the API Feeds.
The endpoint URLs and developer information can be found in the below documentation:
Each individual API Feed end-point is restricted to 5000 requests per hour, unless your accessplanit platform is hosted on a dedicated server (please contact our customer support team if you are unsure of this)
The accessplanit API uses HTTP verbs appropriate for each action:
We do not currently support deletion of accessplanit records through the API Feed, only GET, POST and PUT.
A token is required to make any requests on the API. Tokens should be included with every request.
Tokens are valid for 60 minutes from issue and must be included with every request. The token must be included as a Request Header of Authorization with the value Bearer tokenValue
The status of the response is used to provide feedback about the request:
OK – action completed successfully
Created – Record created successfully
Error – See “errors” section
Not authorized – token has not been provided or is invalid
Not found – url is incorrect or record does not exist
If an error occurs during an operation, the response will have a 400 status code. The response will have a property of Message, which will give clearer information of what issue has occurred. In the case of updating/editing records, another property, ModelState, will be populated. See below for an example response:
"Message": "The request is invalid.",
"An error has occurred."
Although there is documentation, the API is designed around HATEOAS principles and encourages self-discovery through the inclusion of links. Consider the example below:
The Links property defines all the links that are applicable to this company. It also defines which actions are suitable for the provided links. Note how there are two Self-links, but one has the GET action and the other supports the PUT action. This defines that the Company supports being read as well as being updated.
Please note: Heavy use of the API Feeds may negatively impact platform speed and performance.
Each GET call will retrieve the first 500 records.
Pagination is needed within the feeds if you are requesting a large amount of records.
For this, you can use the query string parameters PageSize and PageIndex.