Skip to main content
A autenticação garante a segurança e privacidade dos dados dos usuários. Nesta API, utilize os headers User-Token e User-Secret-Key em todas as requisições. Ambos são obrigatórios.

Como obter suas credenciais

No painel administrativo da Yampi, acesse Perfil > Credenciais de API no canto superior direito para encontrar suas credenciais.
As credenciais de API são renovadas automaticamente quando a senha de acesso do usuário é alterada.

Verificando o Usuário Autenticado

Após obter o User-Token e o User-Secret-Key, você pode utilizar o endpoint abaixo para consultar os dados do usuário autenticado, incluindo as lojas associadas, status de assinatura e permissões de acesso.

Endpoint

Headers

Campos da Resposta

User Object
Informações do usuário autenticado
array of Store Objects
Lista de lojas vinculadas ao usuário
object
Plano ativo da loja
object
Serviços integrados à loja
object
Campos adicionais relacionados ao usuário e loja

Observações Técnicas

  • Essa rota não requer payload no corpo da requisição.
  • Retorna todos os dados do usuário com base no token enviado.
  • Pode ser usada para identificar o dono da loja, checar permissões e validar assinatura.