Promoting the safe and effective use of powered access
API Endpoints
Endpoints
Here are the currently enabled endpoints within the Data Services. To explore their capabilities click on the endpoint links below to view the "Swagger Definitions". These definitions allow anyone to visualize and interact with the API’s resources without having any of the implementation logic in place. The visual documentation makes it easier for back end implementation and client side consumption.
Licence Endpoint
Provides access to licences, associated status, and PAL card information.
Provider Endpoint
Provides access to Training Centre and Training Provider information.
Certification Endpoint
Provides access to Categories, Schemes and Grades information.
Content Endpoint
Provides access to document, photographic and certificate resources.
Operations Endpoint
Provides access to User and Profile information.
Course Endpoint
Provides access to course and application resources.
Microservices
The Data Services REST API works on the principles of Microservices architecture. A principle of developing an application as a suite of small services, each running in its own process and communicating with lightweight mechanisms, i.e. through a HTTP resource API.
These smaller services are built around particular business capabilities and work together to achieve the full business need. The seperation of concern allows for streamlined deployment, efficient handling of user requests and a further means to control access to IPAF resources.
This makes it critical for developers to use the HAL Links for navigation and acknowledge status codes on responses provided. The decision to move to this approach was to allow IPAF's ever-growing ecosystem to adapt to the demand placed on its services from validating Licences to providing business critical information.
