Skip to main content
A API da Yampi suporta dois métodos de autenticação. A escolha depende do tipo de integração que você está construindo.

​
Comparativo

​
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.

​
Critérios de decisão

Integração pessoal vs. app publicado: Se o acesso é apenas para a sua própria loja, o User Token é suficiente. Se outros lojistas precisam autorizar o seu app, use OAuth 2.0. Duração do acesso: O User Token não expira por tempo, o que facilita integrações de longa duração sem reautenticação. O OAuth 2.0 exige renovação periódica via Refresh Token, mas oferece revogação de acesso granular por lojista. Escopos: O User Token concede acesso total à conta do usuário. O OAuth 2.0 permite restringir o app a apenas os recursos necessários (ex.: somente leitura de pedidos), o que é exigido para publicação na Loja de Apps.