Introduction
The Social Security portal offers employers several secure REST services (APIs). To integrate one of these REST APIs into their IT system, the company's manager and IT department (or a software provider/integrator) must complete the following steps.
Step 1 Registration and management of your company's access
If your company is not yet registered on the social security portal, you need to take the necessary steps to identify yourself as an NSSO employer and define the person(s) responsible for managing access to the portal's features.
The required operations are detailed in the ‘Prerequisites’ section of the REST Channel Configuration in Chaman.
Step 2 Configuration of the REST channel in Chaman
To gain access to the social security REST APIs, you need to activate and configure this channel in the Chaman online service. This step also requires your company to possess a certificate.
The required configuration is explained in the REST Channel Configuration in Chaman section.
Integrators wishing to implement software for a company must ensure that the REST channel configuration in Chaman has been properly completed by the company's Access Manager. Despite the technical nature associated with configuring the REST channel in Chaman, these steps can only be handled by a company Access Manager (or one of the designated technical managers).
Step 3 Security - Obtaining an access token
To gain access to the social security REST APIs, an ‘access token’ must be obtained from the social security OAuth server. Obtaining this access token requires the authentication of your client application via the OAuth Client Credentials protocol.
The instructions to follow are included in the developer's guide.
Step 4 Security - Attaching the access token to your calls
In order to get the authorization to use the social security REST APIs, a valid access token must be present in each of your calls to these APIs.
Documentation on how to attach your access token to calls is available in the developer guide.
Step 5 Integrating the API into your application
The functional integration of an API into your application depends on the operations available on that API. Each API has a descriptive file (Swagger/OpenAPI) and a guide to help better understand their use.
The documentation is specific to the API you wish to integrate and can be found on the corresponding dedicated page (listed in the table below).
| REST API name | Related web page in French | Related web page in Dutch |
|---|---|---|
| Dimona | Dimona via web service (in French) | Dimona via web service (in Dutch) |
| CareerPro FLA | CareerPro Federal Learning Account – Gérez les comptes de formation (in French) | CareerPro Federal Learning Account – Opleidingsrekeningen beheren (in Dutch) |
| CIAO (Check In And Out) | Comment vos collaborateurs enregistrent-ils leurs présences dans Check In and Out at Work ? (in French) | Hoe registreren uw medewerkers aanwezigheden in Check In and Out at Work? (in Dutch) |
| BillRetainment | Obligation de retenue via web service (in French) | Inhoudingsplicht via webservice (in Dutch) |
| BELparcel |