What is Fidelidade Developer Portal?

Fidelidade Developer Portal is a public portal provided by Mulesoft Anypoint Platform aiming to provide Fidelidade partners with a centralized solution to access his APIs in an integrated way. Published API's will contain all technical and business details necessary for a successful integration.

How can I join Fidelidade Public Portal and start using the APIs?

Start by creating a Mulesoft Anypoint platform account and request access to the APIs.

For more information, please refer to the Onboarding and API Access pages, where you can find the necessary procedures.

Who is Fidelidade Public Portal for?

For partners that need to integrate with Fidelidade public APIs.

What is the the Mock Service provided in the portal for each API?

The Mock service is a free-to-use API instance, automatically provided, that conforms to its specification and returns static data as if the real instances (sandbox or production). Partners can use it as a trial API while they don't have access to the actual environments.

Which Environments are available for each API?

Fidelidade's public integration infrastructure provides 2 environments:

• Sandbox/Tests - The test environment that connects to non productive private Fidelidade environments (non-real data).
• Production - The production environment that connects to the productive private Fidelidade environment (real data)

Important: Access to each environment (for every API) must be individually requested.

How can I subscribe to APIs?

To subscribe or request access to an API the partner must authenticate in the Portal and access the API main page where he can find a 'Request Access' button. All request accesses must be manually approved by Fidelidade.

For more information, please refer to the API Access page, where you can find the necessary procedures.

What are MuleSoft Applications and why do I need them?

MuleSoft Applications identify the consumers of the APIs and work as credentials to access them. When requesting access to an API, that access is bound to a MuleSoft Application and its corresponding client_id and client_secret values.

For authentication and authorization purposes, client_id and client_secret should be sent as HTTP headers in every API call.

Important: In order to uniquely identify the partner, Mulesoft Applications names should conform to a specific format. Please refer to the API Access page

Where can I see my own MuleSoft Applications?

After logging in, you can see your MuleSoft Applications in the [My Applications][1] section of Developer Portal. There you can find the values for client_id and client_secret (authentication credentials).

How are the APIs secured?

All Fidelidade Public APIs are secured at transport layer by HTTPS TLS (1.2). Also for authentication and authorization, client_id and client_secret should be sent as HTTP headers in every API call.

Only manual approved Mulesoft Applications (client_id and client_secret) are authorized to invoke an API in a given environment.

Where do I see the complete endpoints for each API?

For security reasons, the complete API endpoints are not publicly disclosed. The partner should request this information to Fidelidade when asking for the access approval.

Can a partner register more than once?

No. Each partner should only have one account.

That why it's important that the email address used when creating the account belong to the organization itself and not to a collaborator. This way the account is owned by the partner organization and can be accessed, even if the collaborator that created it left the organization.

If the partner wants to create more than one account it should contact Fidelidade.

How many applications can I register?

Each partner should only have 2 applications: one for the sandbox environment and another one for production.

All API access requests should be done using the corresponding application of the target environment.

If the partner wants to create more than 2 Mulesoft Applications it should contact Fidelidade.

What are SLAs?

The SLAs, or Service Level Agreements, define the limits when calling an API. When selecting a tier in the access request page, you can see the limits in number of requests per time period.

If your needs exceed the Standard tier limitations, contact Fidelidade to negotiate access to a higher Tier.

Contact Us

For any business and/or technical doubt or issue regarding a particular API or the general procedures, please reach us via the standard contacts.