Activating and managing your REST channel in Chaman

The various REST APIs of the Social Security portal are defined in an OpenAPI 3 specification file which explains the API resources, request and response message schemes.

openapi: 3.0.3
info:
  title: Demo v1 - REST API
  version: 1.0.0
servers:
  - url: https://services.socialsecurity.be/REST/demo/v1
security:
  - Oauth:
      - scope:demo:consult
paths: { ... }
components:
  schemas: { ... }
  securitySchemes:
    Oauth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://services.socialsecurity.be/REST/oauth/v5/token
          scopes:
            scope:demo:consult: this scope allows to consult data

All APIs are protected using the OAuth2 security protocol. In order to call any of our APIs, your client application must request an access token from the Social Security OAuth2 authorization server. Subsequently, the obtained access token must be sent with each of your calls to the REST APIs. The following sequence diagram shows the main interactions of this process.