Client ID
da sua integração, é necessário informar a redirect_url
da integração. Essa URL será usada para redirecionar o usuário à sua aplicação, onde o processo de integração será concluído.
http://localhost/sua-url-de-redirecionamento
como URL de redirecionamento.Code Challenge
, que será enviado no redirecionamento para autorização e na solicitação do Access Token
.
Code Challenge
usando o Code Verifier
:
https://auth.yampi.com.br/oauth/authorize
.
Você usará o Client ID
gerado no passo 1, o Code Verifier e o Code Challenge para solicitar um Authorization Code
ao Authorization Server da Yampi.
O Authorization Server retornará o Authorization Code
, que será usado pelo seu aplicativo para requisitar o Access Token
, o Refresh Token
e o alias da loja integrada.
Authorization Code
gerado, seu aplicativo deve obter um Access Token
antes de acessar dados de uma loja pela API Yampi.
O Access Token
pode conceder uma ou mais permissões de acesso, configuradas no painel de parceiros por meio do scope (escopo). O scope define quais rotas da API podem ser acessadas.
Durante a instalação do aplicativo, o usuário será solicitado a conceder as permissões solicitadas. Esse processo é chamado de consentimento do usuário.
Se o usuário conceder permissão, o Authorization Server da Yampi redirecionará o usuário ao seu aplicativo com um Authorization Code
e o merchant
da loja integrada.
Formato da requisição para obter o Access Token
:
Access Token
, ele deve ser incluído no cabeçalho das chamadas HTTP do seu aplicativo.
Formato da requisição com os cabeçalhos obrigatórios: access_token
e X-Partner-Client-ID
:
Access Token
tem um tempo de vida limitado. Tokens gerados pelo fluxo PKCE Authorization Code permanecem válidos por 10 minutos, enquanto o Refresh Token
é válido por 30 dias.
Seu aplicativo deve obter novos tokens antes que o Refresh Token
expire.
Formato da requisição para gerar um novo Access Token
: