A API da Yampi suporta dois métodos de autenticação. A escolha depende do tipo de integração que você está construindo.Documentation Index
Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt
Use this file to discover all available pages before exploring further.
Comparativo
| Critério | User Token | OAuth 2.0 |
|---|---|---|
| Caso de uso | Integração pessoal ou interna | Aplicativo publicado na Loja de Apps |
| Quem autoriza | O próprio usuário da conta | Lojistas que instalam o app |
| Duração do acesso | Longa duração (expira apenas se a senha mudar) | Access Token (10 min) + Refresh Token (30 dias) |
| Escopos | Acesso completo à conta | Permissões granulares definidas por escopo |
| Complexidade | Simples, basta incluir dois headers | Fluxo PKCE com redirecionamento e troca de tokens |
| Onde obter | Painel da Yampi → Perfil → Credenciais de API | Painel de Parceiros Yampi |
Quando usar cada método
User Token
Use quando você está construindo uma integração para a sua própria loja ou para uso interno, como scripts, automações, integrações diretas com ERPs ou ferramentas internas.Não requer fluxo de autorização: basta copiar as credenciais do painel e incluí-las nos headers de cada requisição.
OAuth 2.0
Use quando você está desenvolvendo um aplicativo que outros lojistas instalarão pela Loja de Aplicativos da Yampi.Obrigatório para apps publicados no Portal de Parceiros. Permite definir escopos de permissão e agir em nome de múltiplos lojistas com consentimento explícito.