Integrate with the accessplanit API v2 Feeds - Overview

On this page:

Useful Help Guide Links

API v2 - Developer Resources

Integrate your financial data with your accounting system using the API v2 Feeds

Integrate your courses with your website using the API v2 Feeds

Useful External Links

https://www.accessplanit.com/api-terms-of-use

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

What are the v2 API Feeds?

Why Use API Feeds?

API feeds are a powerful method for creating responsive, efficient, and secure integrations between your accessplanit platform and other software in use within your business.

API feeds facilitate automated access to the most current data stored within your platform, this means that your applications and systems are always working with the latest information, and reduces the need for manual data transfers/rekeying, this minimises human error and could save your team hours each week!

Additionally, APIs are built to scale as they can handle large amounts of data and requests, this means that they can grow alongside your business without much additional work!

What are the differences between accessplanit’s v1 and v2 feeds?

There are two versions of API feeds available for you to use to connect to your accessplanit platform:

• Version 1 (v1)
  Introduced in 2019, the v1 feeds have access to core modules (including course data, user and account data, and financial data), making them ideal for many standard integrations.

• Version 2 (v2)
  Launched in 2024, the v2 feeds offer extensive coverage of your entire platform, enabling integrations with a wider range of applications, and more complex integrations. This also extends to the field access, in v1 you can work with a set of predefined fields for each API endpoint, whereas in v2 you can access all fields that you can access in the platform.

In addition to the significantly wider data access, v2 also benefits from the following:

• Field Selection
  While v1 feeds return every field every time, within v2 you can choose which fields you would like to be returned in your responses which optimises your requests, improving performance, and ensuring that your applications receive only the relevant information.

• Advanced Filtering
  The v1 feeds have support for applying multiple filters to your data requests, however v2 supports both AND and OR operators to refine your queries for much more precise data retrieval, enabling you to filter and access only the information needed for your integration.

• Custom Fields
  The v2 feeds have full access to every Custom Field you have created in your accessplanit platform, this means that the unique data required for your processes is available to make your integrations as useful and relevant as possible.

• Sorting
  The v2 feeds support sorting your data using the 'order by' feature, this means that you can organise and present your data in the most relevant way for your integration!

• Record Deletion:
  Where your login allows you to delete data, so will your v2 feed access! This functionality allows you to manage your data integrity by removing obsolete or incorrect records, this means that your platform data remains accurate and up-to-date.

• Record Count:
  Your v2 feeds can include a count of the number of records that meet your integration criteria, this means that your integration can assess the volume of data, understand how many pages of data there are, and optimise performance in data processing tasks.

Open

To begin using our API feeds, you'll need access credentials. Once granted, you can start building custom integrations tailored to your specific needs. Our detailed documentation and support resources are here to assist you every step of the way.

Explore the sections below to learn more about the capabilities of our v1 and v2 API feeds, how to get started, and best practices for creating efficient and reliable integrations.

API Use Cases

Here are the most popular uses for the API Feeds, supported by our recommended approach and best practice for each

• Integrate your financial data with your accounting system using the API v2 Feeds

• Integrate your courses with your website using the API v2 Feeds

• Integrate your webinar data with your online meeting software using the API v2 Feeds

• Integrate your customer data with your CRM using the API v2 Feeds

• Integrate your course and delegate data with your LMS using the API v2 Feeds

• https://accessplanit.atlassian.net/wiki/spaces/HG/pages/3250978817

• Integrate your customer data with your My Account page using the API v2 Feeds

• Integrate your award and compliance data with an accreditation / awarding body using the API v2 Feeds

• Integrate your customer data with a your/your customers' HR software using the API v2 Feeds

How to access the v2 API Feeds

Access to the API Feeds is an additional module.

To be granted access to the feeds, or if you have any questions you would like to ask us, please contact your Customer Success Manager (CSM).

Developer Resources

Developer information can be found in the below documentation:

Core resources:

API v2 - Developer Resources

Specific integration resources:

Dev Guide: Integrate your financial data with your accounting system with the API Feeds v2archived

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)

FAQs

• Is the data provided by the API v2 feeds in real-time?
  Yes, each API GET request you make will return real time data for that moment
  
  

• Can I access historical data in the API v2 feeds?
  Yes, you can adjust your filters of your request to include or exclude historical data
  
  

• How is the data transmitted via the API to keep it secure?
  The APIs can only be accessed by users with API permissions.
  Additionally the range of access to the feeds is then limited by roles, this means that not every API User can access all of the available data, they can only access the data that is available to their user.
  
  

• How do I get access to the API v2 feeds?
  Your initial API Access will be granted alongside the module purchase
  For any additional API Users please speak to your Optimise CSM and they will ensure your access is set up promptly