fig-motor-sgs-b2b-xapi

1.0.x
(0 reviews)

Overview

This API provides a REST interface to communicate with Motor SGS Services.
For more information on each of these functionalities, please refer to the description of each resource on the left navigation pane.

Use Cases

Manual Green Card - manageSegurnetBSG

  • PATCH : /segurnet-manual-green-cards/{registrationNumber}

  • Resource used to manage the Segurnet associated to a registration number . Returns Segurnet number

Get Segurnet Number - getSegurnetBSG

  • GET : /segurnet-numbers:/{registrationNumber}

  • Resource used to return the Segurnet information associated to a registration number

Communication

This API uses Client Id Enforcement. With Client Id Enforcement, client id and secret are supplied with each request. The API is exposed over the HTTP protocol.

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 X 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.

Application Logging

The out-of-the-box logger component offered by Mule Runtime is easy to use and understand, however, it hardly enforces any standards and it does not facilitate the creation of structured logs.

The implemented logging solution has the ability to log all the steps of message processing within a Mulesoft flow, with a full-fledged JSON message in each of the logging steps.

This eases up the software development lifecycles as developers will not need to worry about or spend time setting correlation IDs, tracepoints, calculate elapsed times, and every other single piece of data that can be derived from the environment or from MEL/ Dataweave expressions.

This API uses the common Mule Logger Foundational Asset. For more information please refer to

https://eu1.anypoint.mulesoft.com/exchange/e571664f-efac-4062-8354-117d2c9c30d4/mule-logger/

Error Handling

The motor siap sapi REST API responds with standard HTTP status codes, with 2** responses indicating a success, 4** responses indicating a client error, and 5** indicating a server error. Notice that this specification does not specify common error responses like 500 (internal server error) or 401 (unauthorized) for the individual resource operations. Clients should however be capable of handling such responses.

The API uses the common Error Handler Foundational Asset. For more information please refer to https://eu1.anypoint.mulesoft.com/exchange/e571664f-efac-4062-8354-117d2c9c30d4/mule-error-handler/

Reviews