README

Agora você pode incluir o processo de autorização do Melhor Envio no seu projeto de e-commerce de forma rápida e simples.

Índice

Instalação
Cofiguração Inicial
Exemplos de uso
- Gerando o Access Token
- Refresh Token
Testes
Changelog
Contribuindo
Segurança
Créditos
Licença

Dependências

require

PHP >= 7.4
Ext-json = *
Guzzlehttp/guzzle >= 7.0

require-dev

phpunit/phpunit >= 9.5

Instalação

Você pode instalar o pacote via composer:

composer require melhorenvio/auth-sdk-php

Configuração inicial

Logo após a instalação concluída, você irá preparar os dados a serem passados como parâmetro para a classe OAuth, lembrando que esses dados são os mesmos que são gerados por você no site do Melhor Envio na criação do aplicativo.

Se você ainda não fez esse passo, basta acessar https://melhorenvio.com.br/painel/gerenciar/tokens.

$appData = [
    'client_id' => 'your-client-id',
    'client_secret' => 'your-client-secret',
    'redirect_uri' => 'your-redirect-uri'
];

Em seguida, você instanciará a classe OAuth passando os parâmetros que você recebe acima.

$provider = new OAuth2($appData['client_id'], $appData['client_secret'], $appData['redirect_uri']);

Exemplos de uso

Uma vez a classe OAuth estando estanciada, você irá informar os escopos que serão necessários para a sua aplicação utilizando o método setScopes(), podendo ser um ou vários. Scopes são as permissões para as ações que o usuário pode ter com o token gerado, por exemplo, ver pedidos, ver carrinho de compras, enviar pedidos, etc.

Lembrando que os escopos estão disponíveis para consulta na documentação da API do Melhor Envio, neste link: https://docs.menv.io/?version=latest#03becc90-8b38-47bd-ba14-7994017462f0

Logo em seguida, faça o redirecionamento para URL retornada pelo método getAuthorizationUrl().

$provider->setScopes('shipping-calculate');
header("Location: {$provider->getAuthorizationUrl()}");
exit;

Visualizando Scopes utilizados

Para visualizar o scopes utilizados, ou seja, as permissões de acesso para token que será gerado, basta utilizar o método getScopes(), esse método irá retornar um array com os scopes utilizados.

$authData[] = $provider->getScopes();

Gerando o Access Token

Bom até aqui vimos como instanciar a classe OAuth, escolher os escopos a serem utilizados e montar a URL, porém quais são os próximos passos?

Temos o seguinte cenário, onde você irá utilizar o método getAccessToken(), para obter a resposta com as informações das credenciais necessárias para você ter êxito na realização de requisições para a API do Melhor Envio.

$authData[] = $provider->getAccessToken($_GET['code'], $_GET['state']);

Um exemplo da resposta dessas informações:

Array
(
    [0] => Array
        (
            [token_type] => Bearer
            [expires_in] => your-token-expiration-timestamp
            [access_token] => your-token
            [refresh_token] => your-refresh-token
        )

)

Definindo URL de callback

Após o usuário confirmar a autorização de uso de sua conta Melhor Envio, a API do Melhor Envio irá realizar uma request para a sua aplicação contendo o code necessário para a solicitação de token. Para definir essa URL de callback basta utilizar o método setRedirectUri() passando com parâmetro a URL que será utilizada, lembrando que essa URL precisa existir e ser válida, e deve ser a mesma URL informada no cadastro de aplicativo dentro da plataforma do Melhor Envio.

$provider->setRedirectUri('http://foo.com.br/callback');

Visualizar URL de callback

Para visualizar qual URL de callback o SDK está utilizando, basta utilizar o método getRedirectUri().

$provider->getRedirectUri();

Refresh Token

Após 30 dias o seu token irá expirar. Mas não se preocupe, o pacote oferece o método de refresh token para que você deixe sua aplicação preparada para quando isso acontecer.

Como essas informações foram geradas anteriormente, você irá utilizar o método refreshToken() passando como parâmetro o dado respectivo, tendo como resposta um novo token.

$newAuthData = $provider->refreshToken($authData['refresh_token']);

Visualizar Endpoint

Para visualizar o endpoint usado no SDK para utilizar o método getEndpoint()

$newAuthData = $provider->getEndpoint();

Ambientes

O SDK funciona em ambos ambientes do Melhor Envio, Produção e Sandbox, para isso funcionar de forma adequeada, é necessário informar qual ambiente está sendo utilizado, por padrão o ambiente usado é o ambiente de sandbox, para fazer a troca de ambiente basta utilizar o método setEnvironment() passando como parâmetro uma string informando o ambiente (sandbox ou production).

$newAuthData = $provider->setEnvironment('production');

Testing

composer test

Changelog

Consulte CHANGELOG para mais informações de alterações recentes.

Contribuindo

Consulte CONTRIBUTING para mais detalhes.

Segurança

Se você descobrir algum problema de segurança, por favor, envie um e-mail para tecnologia@melhorenvio.com, ao invés de usar um issue tracker.

Créditos

Licença

Melhor Envio. Consulte Arquivo de lincença para mais informações.

melhorenvio / auth-sdk-php

Maintainers

Details