OpenAPI

In addition to consuming the API through the web service or the DLL client, it is possible to use the OpenAPI (v3) specification published by SDH to integrate with DeCA.

The specification is available in JSON format at the following URL:

https://decatest.solmicrosdh.com/openapi/v1.json

What is it for?

This specification formally and always up-to-date describes all the endpoints, parameters, request/response schemas and status codes of the DeCA REST API. It can be used, among other things, to:

• Import it into tools such as Postman or Insomnia to interactively explore and test the API.
• Automatically generate clients (SDK) in the desired programming language using OpenAPI-compatible code generators, such as OpenAPI Generator or NSwag.
• Validate that a third-party integration's requests and responses comply with the contract defined by SDH.
• Keep the technical integration documentation in sync with the actual deployed version of the service.

Included endpoints

The specification covers the following endpoints described in the DeCA API documentation:

• POST /api/control-documents - Create new DeCA.
• PUT /api/control-documents/{id} - Update DeCA.
• DELETE /api/control-documents/{id} - Delete DeCA.
• POST /api/control-documents/{id}/resend-notification - Resend DeCA.

Considerations

• The OpenAPI specification does not include the security scheme, so it is still necessary to meet the Authentication requirements and include the CompanyId header, as indicated in the web service section.
• Since this document is automatically generated from the service code, it may change between versions; it is recommended to download it periodically rather than keeping a static copy in the integration project.