Skip to main content

​
Visão geral

Nós preparamos uma API Collection com todos os endpoints documentados. Com ela, você pode importar toda a estrutura da API, incluindo requisições, parâmetros e exemplos de payloads, eliminando a necessidade de configuração manual.
Além do Postman, também é possível importar esta Collection em Insomnia, Hoppscotch ou Thunder Client (VS Code).

​
Download da Collection

Disponibilizamos duas versões da Collection, cada uma configurada para um tipo de autenticação.
  • Versão: Autenticação via Credenciais - Ideal para testes rápidos e integrações diretas usando as credenciais de API: Alias, User Token e User Secret Key.
  • Versão: Autenticação via OAuth 2.0 - Ideal para Parceiros Desenvolvedores Yampi. Inclui scripts para gerenciar o fluxo de autorização OAuth 2.0 de ponta a ponta.
Escolha a que se encaixa melhor no seu uso.

🔑 Autenticação por Credenciais

Collection configurada para uso com Alias, User Token e User Secret Key.

🔐 Autenticação via OAuth2.0

Collection preparada para o fluxo completo de autenticação com OAuth2.0.

​
Como importar a Collection no Postman

1

Baixe a Collection

Escolha e baixe o arquivo .json da Collection desejada (Credenciais ou OAuth2.0).
2

Importe o arquivo no Postman

Clique em Import → File → selecione o arquivo .json baixado.
3

Verifique a Collection

A Collection aparecerá na sua barra lateral esquerda.
Antes de tudo, é preciso configurar as variáveis da Collection. Cada versão possui variáveis específicas para autenticação (detalhadas abaixo).

​
Configuração das variáveis

Abra a Collection → aba Variables e configure:
  • Alias → valor disponível no painel Yampi em Perfil > Credenciais de API.
  • User-Token → valor disponível no painel Yampi em Perfil > Credenciais de API.
  • User-Secret-Key → valor disponível no painel Yampi em Perfil > Credenciais de API.
Com essas variáveis configuradas, todas as requisições já estarão autenticadas automaticamente e prontas pra uso.
Abra a Collection → aba Variables e configure:
  • Partner-Client-ID → client_id do seu app no painel do parceiro desenvolvedor Yampi.
  • Redirect_URI → URI de redirecionamento cadastrada no app.
  • Access-Token → deixe em branco no primeiro uso.
  • Refresh-Token → deixe em branco no primeiro uso.
  • Token-Expires-At → deixe em branco no primeiro uso.
  • AuthCode → deixe em branco no primeiro uso.
  • Code_Verifier → deixe em branco no primeiro uso.
  • Code_Challenger → deixe em branco no primeiro uso.
1

Inicie a autorização

Execute a request Iniciar Autorização (gerar e abrir URL) e copie a url que foi gerada e salva na variável AuthorizeURL em Variables.
2

Autorize no navegador

Abra a URL, faça login, autorize e copie a URL de redirect recebida.
3

Cole a URL de redirect

Cole a URL de redirect reciba no body da request OAuth2 - Colar URL de Redirect (capturar código) e execute-a → isso salva AuthCode e Alias automaticamente.
4

Troque o código por token

Execute a request OAuth2 - Trocar Código por Token → isso gera e salva automaticamente Access-Token e Refresh-Token.
Feito, todas as requisições já estarão autenticadas automaticamente e prontas pra uso.

​
Verificação rápida

Recomendamos testar alguma request, como por exemplo GET /catalog/brands logo após configurar as variáveis. Se o retorno for 200 OK, a configuração foi um sucesso!
Se tiver dúvidas sobre o uso da Collection ou quiser se aprofundar no ecossistema da Yampi, junte-se à nossa Comunidade Yampi Dev no Discord:

Comunidade Yampi Dev

Faça parte da nossa comunidade de desenvolvedores.