🔒 Authentication and Environments

Authentication in our APIs is done with an API key. It is through this key that our system identifies your account and allows communication with us on that account's behalf. If the API key is invalid, is not sent, or the header is malformed, our API returns an authentication error: HTTP 401 Unauthorized.

🚧 Attention!

The API key is sensitive information and must be handled with care. Do not share your API key with third parties and do not expose it in public places, such as code repositories or inside your application.

Use the following headers to authenticate your application:

Content-Type: application/json
Authorization: ApiKey <your-api-key>

Tip

To get your API key, contact our sales team.

🚦 Environments

Our APIs have two separate environments: staging and production.

TIP

We can issue as many keys as you need. They are useful for separating usage across environments, projects and contexts, and at the end of the month they can be used to group that usage. If you would like to use additional keys, contact our support or sales team and request them.

Staging

https://api-homolog.nxcd.app

The staging environment is meant for testing and developing your application. There you can run integration tests, validate communication with our APIs and simulate real usage scenarios. Given the nature of our products, a mock environment would serve no purpose, so staging is analogous to production: it differs only in having fewer resources available and in receiving new features first, precisely so they can be validated before being promoted to production.

TIP

Because we are constantly rolling out updates to this environment, temporary instability can occur.

Since data is genuinely processed here, we cap usage with a quota for testing and PoCs. Once you are in production, free staging usage is capped at 15% of your contracted allowance; beyond that, transactions are treated as billable.

Production

https://api.nxcd.app

The production environment is where you carry out the final integration of your application, access every available feature and serve your customers with resources and performance ready for high volume and high availability.

Every transaction in this environment is billed.