API Feeds - Overview

Search for a solution

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.

As the API Feeds are an additional module, please contact your assigned Customer Success Manager (CSM).

Responses are in JSON by default, but can be returned as XML; to request XML, add a Request Header of Accept with a value of application/xml

DISCLAIMER: By using accessplanit APIs, you agree to our terms of use.


What platform areas are available within the API Module?

There are three major areas of your accessplanit that are covered by the API Feeds; Courses, Finance, and Users. you may use a combination of these for your integration.

  • Course API Feeds
    There are several endpoints available for Course based information:

    • Course Templates

    • Courses (dates)

    • Delegates

    • Trainers

    • Venues

  • Financial API Feeds
    There are several endpoints available for financial based information:

    • Invoices

    • Invoice Items

    • Transactions (payments)

  • User API Feeds
    There are several endpoints available for user based information

    • Users

    • Companies (accounts)

    • 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.


Developer Documentation

The endpoint URLs and developer information can be found in the below documentation:

https://documenter.getpostman.com/view/10924757/SzYexcAy?version=latest#intro


API Feed Restrictions

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)


HTTP Verbs

The accessplanit API uses HTTP verbs appropriate for each action:

Verb

Description

GET

Retrieve resource

POST

Create resource

PUT

Update resource

We do not currently support deletion of accessplanit records through the API Feed, only GET, POST and PUT.


Authorization

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

Responses

The status of the response is used to provide feedback about the request:

Status Code

Description

200

OK – action completed successfully

201

Created – Record created successfully

400

Error – See “errors” section

401

Not authorized – token has not been provided or is invalid

404

Not found – url is incorrect or record does not exist

Errors

 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.",

    "ModelState": {

        "user.DateOfBirth": [

            "An error has occurred."

        ]

    }

}

Self-Discovery

Although there is documentation, the API is designed around HATEOAS principles and encourages self-discovery through the inclusion of links. Consider the example below:

  {

        "CompanyID": "Example1",

        "Name": "Example Company",

        "MainContactUserID": “exmp1”,

        "EmailAddress": "",

        "ExternalID": null,

        "AddressLineOne": "12 Lancaster Street",

        "Town": "Lancaster",

        "County": "Lancashire",

        "Postcode": "LA1 1NY",

        "Country": "United Kingdom",

        "Links": [

            {

                "Rel": "Self",

                "Href": "/api/v1/companies/Example1",

                "Action": "GET"

            },

            {

                "Rel": "Self",

                "Href": "/api/v1/companies/Example1",

                "Action": "PUT"

            },

            {

                "Rel": "CompanyGroups",

                "Href": "/api/v1/companies/Example1/companygroups",

                "Action": "GET"

            },

            {

                "Rel": "MainContactUser",

                "Href": "/api/v1/users/exmp1",

                "Action": "GET"

            }

        ]

    }

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.


Pagination 

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.

PageSize = the number of results to return

PageIndex = the page to return

Please note that PageIndex starts at 1, not 0.

Example:

GET 'https://systemname.accessplanit.com/accessplan//api/v1/users?PageSize=10&PageIndex=2'

 


FAQs

Q. Do you support requests via webhooks?
A. Unfortunately we do not yet support webhooks.

If this functionality would be helpful to you please log this as a product suggestion in our Product Portal, please include how you would use this feature.