- Novo Saque – Portal de Integração para Parceiros

Autenticação e credenciais

A API da Novo Saque utiliza autenticação por chave de acesso (API Key). Todas as requisições devem ser autenticadas para serem processadas.

📌

As credenciais são fornecidas pela Novo Saque após a conclusão do processo de habilitação do parceiro (conforme descrito em Comece por aqui).

A autenticação é realizada por meio do header HTTP:

X-Api-Key: SUA_CHAVE_DE_ACESSO

Esse header deve estar presente em todas as requisições, independentemente do endpoint ou ambiente.

As chaves de acesso são específicas por ambiente.

Sandbox: utilizada para testes e homologação
Base URL: https://api.novosaque.dev.br

Produção: utilizada para operações reais
Base URL: fornecida no momento da habilitação do parceiro

Uma chave de Sandbox não funciona em Produção e vice-versa.

Recomendamos que o parceiro:

Armazene a chave de acesso de forma segura

Não exponha a chave em código-fonte público

Não compartilhe a chave entre parceiros ou aplicações distintas

Revogue e solicite nova chave em caso de comprometimento

Quando a autenticação falha, a API retorna erros HTTP específicos:

401 Unauthorized: chave ausente ou inválida

403 Forbidden: chave válida, porém sem permissão para o recurso solicitado

Ao receber erros de autenticação, verifique se a chave está correta e se o ambiente utilizado corresponde à credencial fornecida.

Exemplo utilizando o ambiente de Sandbox:

Se a chave estiver correta, a API não deve retornar 401/403