# Autenticação

Nossa API está hospedada no seguinte subdomínio:

api.cnpja.com

Todas as consultas devem ser realizadas via protocolo https, não suportamos http.

https://api.cnpja.com/office/00000000000191

http://api.cnpja.com/office/00000000000191

Ao enviar uma requisição, é mandatório fornecer uma chave pessoal na propriedade Authorization dos headers.

Oferecemos autenticação via Chave de API ou JWT.

Falhas em fornecer uma chave válida irão resultar em status 401 no retorno da API:

{
  "code": 401,
  "message": "invalid authorization header"
}

# Chave de API

A Chave de API é uma string de 73 caracteres, utilizada para identificar seu usuário.

Ela será automaticamente gerada ao registrar-se em nossa plataforma e confirmar seu e-mail.

Para visualizá-la ou recriá-la acesse:

Minha Conta


# JWT

JSON Web Token (JWT) permite que suas chaves sejam rotativas, expirando a cada uma hora.

Desta forma, é adicionado uma camada de segurança em suas credenciais no caso de incidentes com sua aplicação.

Para autenticar via JWT é necessário enviar um requisição a nossa rota de autenticação com seu usuário e senha da plataforma.

# Gera Token

POST /auth

Body

Propriedade Tipo Descrição
username
Obrigatório
string Usuário (e-mail)
password
Obrigatório
string Senha

Exemplos

Request
{
  "username": "contato@cnpja.com",
  "password": "WH8T#BJT$_aJ[SP%2,%5#yUz~L^<#JFX"
}
Response
{
  "idToken": "eyJhbGciOi...UihRsFV5kA",
  "ttl": 3600
}
Request
{
  "username": "contato@cnpja.com",
  "password": "senha1234"
}
Response
{
  "code": 401,
  "message": "invalid username or password"
}

Tipagem

Propriedade Tipo Descrição
idToken string JWT para autenticação na API
ttl number Tempo de expiração em segundos