Autenticação
Para interagir com a API do Ciabra Invoice, é essencial autenticar suas requisições usando o cabeçalho de autorização. Isso garante que apenas usuários e sistemas autorizados possam acessar e manipular dados na plataforma.
Cabeçalho de autorização
Para cada requisição à API, você deve incluir o cabeçalho Authorization com o valor Basic {token}, onde {token} é uma string codificada em Base64 que combina sua chave pública e chave privada.
Gerando um token
O token é gerado em três passos: combinar suas chaves, codificar em Base64 e configurar o cabeçalho.
1
Combinação de chaves
Combine sua chave pública e chave privada no formato public:private. Por exemplo, se sua chave pública é abc123 e sua privada é xyz789:
2
Codificação em Base64
Codifique a string resultante em Base64. Isso transforma a combinação de chaves em uma string segura para ser usada na autorização.
3
Configuração do cabeçalho
Adicione o cabeçalho Authorization na sua requisição HTTPS, com o valor Basic {token}, substituindo {token} pela string Base64 gerada.
Primeira requisição
A primeira requisição que você deve fazer é para verificar se as credenciais são válidas, utilizando o path /auth/applications/check. Isso ajuda a garantir que o token de autorização esteja correto e ativo.
GET /auth/applications/check Authorization: Basic YWJjMTIzOnh5ejc4OQ==
Se a autenticação for bem-sucedida, a API retornará um JSON com o ID da aplicação e do usuário:
{
"id": "uuid",
"userId": "uuid"
}