✅Autorização

Nossa API segue o padrão de autorização OAuth2.

Quando sua conta de usuário é criada, você recebe as credenciais de acesso para cada ambiente (sandbox e produção). Suas credencias são compostas de 3 valores:

Você pode utilizar simular os processos de autenticação no ambiente sandbox, mas se preferir trabalhar diretamente com a execução de API para autenticação veja os pré-requisitos:

🔑Solicitando um token via sandbox ou produção

O body de sua requisição deve conter (applicatoin/json):

{
username : clientId

Password : clientSecret

grant_type : password
}

Token Retornado

A partir do token retornado, utilizar em cada requisição (enviar no header)

Authorization: Bearer + token

AESKEY : sua AESKEY

Para consultar a documentação e os padrões utilizados no OAuth2, clique aqui

🔑Solicitação de token via postman

Para obter o token, pode-se utilizar uma coleção do Postman, conforme a imagem abaixo:

As principais entidades a serem utilizadas são Cliente e Cobrança.

• Cliente: Nessa entidade, é possível cadastrar um novo cliente e parametrizar as configurações de aviso, como e-mail, SMS e carta. Os avisos podem ser programados para serem enviados com antecedência, no dia do vencimento e até quatro vezes após o vencimento, de acordo com a configuração de cada cliente.
• Cobrança: Após o cadastro do cliente, é possível gerar cobranças associadas a ele.

É importante ressaltar que:

• Criptografia: Todas as mensagens, exceto o token, são criptografadas utilizando o algoritmo AES-128. A chave de criptografia é obtida durante a geração do token. Consequentemente, tanto o corpo da requisição quanto da resposta são JSONs criptografados.
• SDKs: Nossa empresa disponibiliza SDKs que podem ser utilizados como base para o desenvolvimento da integração, facilitando o processo de desenvolvimento.