The ThirdParty API is an API designed for 3rd party software developers that want to pull data from HsM to integrate it with their own system.
The integration API uses Personal Access Token authentication.
This API provides OpenAPI documentation at https://clientservice.hsm.digital//swagger/index.html?urls.primaryName=External%20V2%20API.
The nuget package Hsm.ClientService.ThirdPartyApi.Client can be used to access this API from 3rd party applications. A sample application is available on GitHub.
Authorization
To authorize access to end points of the Third Party API with a PAT the caller must send an Authorization Header based on this PAT in format: Bearer <Base64EncodedPat>.
Example using curl:
curl -X 'GET' \ |
Capability checks
Endpoints on the ThirdParty API that have a customer ID path parameters will require an capability grant for capability THIRD_PARTY_API on the accessed customer. Endpoints with no customer ID will not check this capability grant.
