🔒 Autenticação e Ambientes

A autenticação em nossas APIs é feita através do uso de uma chave de API. É através desta chave que nosso sistema identifica a sua conta e permite a comunicação conosco em nome da conta em questão. Caso a chave de API seja inválida, não seja informada ou o header esteja incorreto, nossa API retornará um erro de autenticação. HTTP 401 Unauthorized.

🚧 Atenção!

A chave de API é uma informação sensível e deve ser tratada com cuidado. Não compartilhe sua chave de API com terceiros e não a exponha em locais públicos, como repositórios de código e em sua aplicação.

Utilize os headers a seguir para autenticar sua aplicação:

Content-Type: application/json
Authorization: ApiKey <sua-chave-de-api>

Dica

Para obter sua chave de API, entre em contato com nossa equipe de vendas.

🚦 Ambientes

Nossas APIs possuem dois ambientes distintos: Homologação e Produção.

TIP

Podemos disponibilizar quantas chaves forem necessárias. Elas são úteis para separar consumo entre ambientes, projetos e contextos e ao final do mês podem ser utilizadas como agrupadores dos consumos. Caso tenha interesse em utilizar mais chaves distintas, entre em contato com nosso time de suporte ou time comercial e faça essa solicitação.

Homologação

https://api-homolog.nxcd.app

O ambiente de Homologação é destinado para testes e desenvolvimento de sua aplicação. Nele, você pode realizar testes de integração, validar a comunicação com nossas APIs e simular cenários de uso. Pela natureza dos nossos produtos, não faz sentido disponibilizar um ambiente de Mock, dessa forma, o ambiente de homologação é análogo ao de produção, se distinguindo apenas por dispor menos recursos e receber primeiramente as novas features, justamente para que possam ser homologadas antes de promovê-las à produção.

TIP

Como estamos constantemente subindo novas atualizações nesse ambiente, pode ocorrer instabilidades temporárias.

Dessa forma, como há o processamento real dos dados limitamos a uma cota para testes e PoC. Quando já em produção limitamos o consumo de homologação free a 15% da franquia contratada, caso exceda essa quantidade, as transações serão consideradas como "tarifáveis".

Produção

https://api.nxcd.app

O ambiente de Produção é destinado para realizar a integração final de sua aplicação, acessar todas as funcionalidades disponíveis e atender seus clientes com recursos e performance preparados para altos volumes e alta disponibilidade.

Todas as transações nesse ambiente serão tarifadas.