Autenticação

Passo a passo para a autenticação através da criação do Aplicativo

Este é o primeiro passo para iniciar a integração com o Melhor Envio. A autenticação deve ser realizada através da criação de um aplicativo no Painel do Melhor Envio. Com ele, a plataforma pode gerenciar os tokens de maneira que lojistas não precisem se preocupar com isto.

Através do aplicativo, o usuário apenas vai dar permissão para que a plataforma possa realizar requisições conforme as permissões concedidas. O usuário não deve possuir acesso aos dados do aplicativo.

No formulário de cadastro de aplicativo, é necessário que sejam preenchidos com atenção todos os campos. Veja:

Tenha cuidado com a URL de callback, já que ela representará o endereço para o qual o Melhor Envio irá redirecionar o usuário após a autorização do aplicativo. Ela deverá representar um endereço válido em sua aplicação e deverá ser idêntica à registrada no cadastro do aplicativo.

A autenticação é baseada no padrão OAuth2. Caso você não esteja familiarizado com este padrão, deixamos a seguir um fluxograma explicando o processo de solicitação da autorização do usuário do Melhor Envio e em seguida já solicitando o primeiro Bearer Token (JWT).

Abaixo você pode ver um exemplo do fluxo para requisição do seu primeiro token de acesso:

Uma vez em posse do primeiro token, você já vai poder realizar requisições aos demais métodos de nossa API que exijam autenticação, desde que você tenha solicitado as permissões corretas, é claro.

Vale lembrar que, salvo raras exceções, sua plataforma possuirá apenas 1 aplicativo cadastrado no Melhor Envio e disponível para toda a base de lojistas da plataforma.

O aplicativo nada mais é que o registro da sua aplicação. As informações deste registro não devem ficar disponíveis para quem usa a plataforma.

Da mesma forma que o usuário não deve ter acesso às informações do aplicativo, ele também não deve ter acesso a tokens ou a qualquer outra informação relacionada à autenticação. A responsabilidade de gerir de forma transparente e segura os acessos à API do Melhor Envio são da plataforma, e não da pessoa que faz uso dela.

Como os tokens possuem uma validade de tempo relativamente curta, 30 dias, é necessário implementar também o método refresh token. Desta forma você vai poder requisitar um novo token sempre que o token anterior expirar, mantendo as permissões ativas por um tempo indefinido.

Para detalhes técnicos sobre Autenticação, clique aqui para consultar o respectivo tópico de nossa referência à API.

Nos processos posteriores, de cotação de fretes e compra de fretes, há fluxogramas descrevendo um modelo para execução do processo de renovação de token.