workcompensation-claims-b2b-xapi

Overview

This API can be used to perform operations related to Work Accidents Claims.
As an example, it can be used to create new claims or participations or retrieve the details of existing ones.

For more information on each of these functionalities, please refer to the description of each resource on the left navigation pane.

Communication

This section indicates how the connection with the API is achieved and regarding the output of the same.

Security

The communication with the API is performed over HTTPS, meaning that the communication is encrypted, providing an additional layer of protection when transporting your information.

Moreover, all requests are performed applying a Client ID Enforcement policy, enabling only authorized consumers to access the API resources.

SLA Tiers

The Standard SLA tier allows you to perform up to 30 requests per minute on the resources of this API.

If your needs exceed these limits, please contact Fidelidade to negotiate access to a higher SLA tier.

Error Handling

Successful requests to the API will return a 2xx status code.

When an error occurs, the API will respond with a status code in the 4xx or 5xx group, enforcing the standard HTTP status codes.

As for the error structure, the API uses a standard structure, that contains the details of the error itself.

Consumers can use the details present in this standard structure to help troubleshoot errors.

In particular, the correlationId can be used by Fidelidade to internally identify the request chain that caused the error.

The following is an example of said structure:

{
  "errorCode": 500,
  "correlationId": "8a9cd990-4888-11ec-8f20-005056b5e555",
  "timeStamp": "2021-11-18T15:59:42Z",
  "description": "The description of the error",
  "detailedDescription": "Further details of the error",
  "externalError": ""
}