Autenticação e ambientes

Autenticação e ambientes

Endpoint público

GET /credit/integrations é público, gratuito e não exige HTTP-API-KEY. Use-o para descobrir integrações ativas, formatos de documento e preços atuais.

curl --fail-with-body --silent --show-error \
  https://api.conexaoazul.com/api/v1/credit/integrations

Qual chave utilizar

A HTTP-API-KEY é provisionada pela Conexão Azul e vinculada à conta técnica do cliente no ambiente Odoo da Blue Credit API.

Ela não é a API key nativa que um usuário gera nas preferências pessoais do Odoo. A API utiliza uma chave do mecanismo auth.api.key, associada ao grupo BLUE_CREDIT_API, ao usuário técnico e ao parceiro responsável por saldo e consumo.

Para solicitar, rotacionar ou revogar uma chave, contate [email protected]. Não reutilize uma chave entre clientes, ambientes ou integrações de terceiros.

Consulta autenticada

POST /credit/query exige a chave no header HTTP-API-KEY e um corpo JSON.

export BLUE_CREDIT_API_KEY='SUA_CHAVE'

curl --fail-with-body --silent --show-error \
  --request POST \
  'https://api.conexaoazul.com/api/v1/credit/query' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "HTTP-API-KEY: ${BLUE_CREDIT_API_KEY}" \
  --data '{"integration_code":"cnpj_completo","document":"11222333000181"}'

Header	Obrigatório	Uso
HTTP-API-KEY	Somente em /credit/query	Identifica a conta responsável pela consulta, saldo e consumo
Content-Type: application/json	Em requisições POST	Informa que o corpo está em JSON
Accept: application/json	Recomendado	Explicita o formato esperado da resposta
X-Request-ID	Opcional	Permite correlacionar a chamada com logs e suporte

Uma chave ausente, revogada ou inválida retorna 401 Unauthorized.

Ambiente de produção

https://api.conexaoazul.com/api/v1

As consultas nesse endereço podem debitar saldo real. Ambientes ou chaves de homologação dependem de habilitação. Confirme a disponibilidade com [email protected] antes de incluí-los em CI/CD ou testes automatizados.

Armazenamento seguro

• Guarde a chave em variáveis de ambiente, secret managers ou cofres de credenciais.
• Nunca coloque a chave em frontend, repositório, imagem Docker, log, ticket ou print.
• Use chaves separadas por cliente e ambiente.
• Restrinja quem pode visualizar, rotacionar e utilizar a chave.
• Em caso de suspeita de vazamento, interrompa o uso e solicite revogação e substituição.

Exemplo de .env

BLUE_CREDIT_API_URL=https://api.conexaoazul.com/api/v1
BLUE_CREDIT_API_KEY=SUA_CHAVE

Inclua .env no .gitignore e forneça apenas um .env.example sem valores reais.

Arquitetura recomendada

Seu frontend → Seu backend → Blue Credit API

Seu backend autentica o usuário final, aplica regras de permissão, valida o documento, chama a Blue Credit API e devolve apenas os dados necessários. Isso evita expor a chave e reduz o risco de consultas indevidas.

Cobrança associada à conta

A chave identifica a conta responsável pela consulta. O catálogo apresenta as tabelas disponíveis, mas o valor efetivamente debitado depende da configuração comercial ativa e é retornado no campo cost. Trate cost como fonte de verdade para conciliação e monitoramento.