Autenticação

O acesso às APIs da Rede Frota requer autenticação para garantir a segurança dos dados e o controle de uso. Utilizamos o padrão de Subscription Key em conjunto com (em alguns casos) autenticação OAuth2/JWT.

Subscription Key

Toda requisição deve incluir a chave de subscrição no cabeçalho. Esta chave identifica o desenvolvedor e o produto associado (ex: Transportadoras ou Fornecedores).

Como enviar

Adicione o header Ocp-Apim-Subscription-Key na sua requisição HTTP.

GET /v1/carriers/vehicles HTTP/1.1
Ocp-Apim-Subscription-Key: sua_chave_aqui_12345
Content-Type: application/json

Nota: Você pode obter suas chaves na área de Perfil após efetuar login no portal.

Como obter sua chave (Passo a Passo)

A Subscription Key é gerada automaticamente quando você se inscreve em um Produto (ex: Transportadoras, Fornecedores). Siga estes passos para obter a sua:

1. Faça login no Portal do Desenvolvedor.

2. Navegue até a página de Produtos no menu superior.

3. Escolha o produto que deseja consumir (ex: Clientes) e clique no botão Subscribe.

4. Após a confirmação, vá para o seu Perfil (clicando no seu nome ou avatar).

5. Na seção Subscriptions, você verá a lista de produtos assinados.

6. Clique no link Show ao lado da Primary Key para revelar sua chave.

Dica Importante

Recomendamos o uso da Primary Key em suas aplicações. Se sua chave for comprometida, você pode usar a função Regenerate no seu perfil para criar uma nova chave instantaneamente, invalidando a anterior.

Autenticação JWT (Bearer Token)

Para endpoints que acessam dados sensíveis ou realizam operações de escrita crítica, pode ser necessário um Token JWT além da Subscription Key. A autenticação é feita por OAuth2 SSO;

A token gerado deve ser enviado no header Authorization:

Authorization: Bearer eyJhbGciOiJIUzI1Ni...