Autenticação
Como realizar o token de autenticação no portal de documentação Rodonaves
Todas os APIs Rodonaves possuem rota token para autenticação de usuário para acesso aos recursos disponibilizados.
Requisição
A requisição token sempre ocorrerá na rota {url}\token no método POST, os parâmetros da requisição sãos enviado no corpo da requisição através do tipo de conteúdo (content-type) application/x-www-form-urlencoded, contendo os seguintes parâmetros:
| Propriedade | Observação |
|---|---|
| grant_type | Utilize o valor password neste campo |
| username | nome de usuário |
| password | senha de acesso |
| companyId | Empresa para busca de informações, opte por utilizar o valor 1, caso precise buscar informações de outras empresas entre em contato com nosso setor comercial |
| auth_type | Tipo de autenticação, nesta etapa opte por utilizar o valor dev |
Utilização
Por padrão, o token de acesso precisa ser informado no cabeçalho de autenticação, antecedendo a palavra Bearer, segue exemplo:
| Cabeçalho (Key) | Valor |
|---|---|
| Authorization | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1laWQiOiIxIiwidW5pcXVlX25hbWUiOiJBRE1JTklTVFJBVE9SIiwiaHR0cDovL3NjaGVtYXMucnRlLmNvbS5ici9pZGVudGl0eS9jbGFpbXMvY29tcGFueWlkIjoiMSIsImh0dHA6Ly9zY2hlbWFzLnJ0ZS5jb20uYnIvaWRlbnRpdHkvY2xhaW1zL3VzZXJjb21wYW55aWQiOiItMSIsImh0dHA6Ly9zY2hlbWFzLnJ0ZS5jb20uYnIvaWRlbnRpdHkvY2xhaW1zL2lzdXNlcm1hc3RlciI6IlMiLCJodHRwOi8vc2NoZW1hcy5ydGUuY29tLmJyL2lkZW50aXR5L2NsYWltcy9hdXRodHlwZSI6IlRNUyIsIm5iZiI6MTYyNDU2MDgxMCwiZXhwIjoxNjI0NTg5NjEwLCJpYXQiOjE2MjQ1NjA4MTAsImlzcyI6InJ0ZWZyYW1ld29yayIsImF1ZCI6IjhFMUQzMEI3LTExODQtNDkxRS1CRDJGLUI5MDA3QkNDNDYwRiJ9.BuTY9wnUhvaNsQBJiLM0bSkicQbimBQq37TYFFRAM_0 |
Snippet de código
Na seção documentação de API, há diversos exemplos da requisição token em várias linguagens de programação, tome por base o que está sendo indicando nestes espaços
Exemplo
Etapa 1
Acesse a opção "Autenticação" da API desejada, preencha o usuário e senha e em seguida selecione "Try it!".
Etapa 2
Copie o conteúdo da propriedade "access_token" (sem considerar as aspas) e cole no cabeçalho da requisição que será apresentado na próxima etapa.
Etapa 3
Preencha o campo "Header" com "Bearer" e cole o token copiado na etapa anterior
Avisos
Atenção!
Cada API possui seu próprio método de autenticação, por conta disso é necessário realizar uma nova requisição de token da API que deseja comunicar.
Updated 6 months ago