Perguntas Frequentes
Principais dúvidas da comunidade ao integrar com a Yampi
🔎 Qual sua dúvida?
- 📡 Como funciona a estrutura de webhooks na Yampi?
- 🔐 O que é OAuth2?
- 📌 Suporte para Parceiros e Desenvolvedores
- 🛠️ Como usar a loja de testes?
- 🔌 Como integrar meu aplicativo à Yampi?
- 🛠️ Como acessar o Painel do Parceiro?
- 🔄 Como funciona a URL de redirecionamento?
- 📚 Onde encontro a documentação da API?
- ⏱️ Como funciona o rate-limit dos endpoints?
- 🤝 Quais plataformas integramos?
- 🧪 Minha conta de testes tem algum custo?
- 📘 Quais os principais retornos HTTP da API da Yampi?
- 🔁 Minha autenticação OAuth2 expira por inatividade do Lojista?
📡 Como funciona a estrutura de webhooks na Yampi?
📡 Como funciona a estrutura de webhooks na Yampi?
A estrutura de webhooks da Yampi é flexível e orientada a eventos. Você pode registrar um único webhook para escutar múltiplos eventos, o que simplifica a integração e centraliza o tratamento de notificações.
Por exemplo, é possível utilizar a mesma URL para lidar com eventos como order.created
e cart.reminder
:
Sempre que um evento for disparado, será feita uma requisição POST
para a URL informada.
Sua aplicação deve responder com status 200
ou 201
em até 5 segundos — esse é o timeout recomendado.
A estrutura do payload recebido é a seguinte:
O campo event
identifica o tipo do evento e resource
contém os dados associados.
Com essa estrutura, sua integração se torna mais eficiente, escalável e segura.
🔗 Veja mais em Webhooks
🔐 O que é OAuth2?
🔐 O que é OAuth2?
OAuth2 é um protocolo de autorização que permite que aplicativos acessem recursos protegidos em nome do usuário, sem expor suas credenciais.
Na Yampi, utilizamos o OAuth2 para garantir que apenas aplicativos autorizados possam acessar os dados das lojas dos clientes.
🔗 Ver documentação OAuth2
📌 Suporte para Parceiros e Desenvolvedores
📌 Suporte para Parceiros e Desenvolvedores
📬 Canal principal de suporte
O canal de suporte para parceiros e desenvolvedores é através do e-mail:
suporteparcerias@yampi.com.br
📚 Base de Conhecimento
Também temos uma base completa de informações, tutoriais e como usar a API em nossa documentação:
🛠️ Como usar a loja de testes?
🛠️ Como usar a loja de testes?
Para testar seu aplicativo, você pode criar uma loja de testes no Painel do Parceiro:
1️⃣ No painel do aplicativo, clique em ‘Testar o aplicativo’
2️⃣ Se ainda não tiver uma loja de teste, clique em ‘Criar loja teste’
3️⃣ Siga as instruções para configurar a loja e instalar o aplicativo
A loja de testes permite simular operações sem impactar dados reais, mas possui algumas limitações, como ausência de confirmação de e-mail e de cobrança de comissões.
🔗 Ver mais sobre loja de testes
🔌 Como integrar meu aplicativo à Yampi?
🔌 Como integrar meu aplicativo à Yampi?
Para integrar seu aplicativo à Yampi, siga estas etapas:
1️⃣ Acesse o Painel do Parceiro e crie uma conta de parceiro, se ainda não tiver uma
2️⃣ No painel, clique em ‘Meus aplicativos’ e, em seguida, em ’+ Novo aplicativo’
3️⃣ Preencha as informações solicitadas, como nome e categoria do aplicativo
4️⃣ Configure a URL de redirecionamento e as permissões necessárias para o aplicativo
5️⃣ Salve as configurações para gerar o Client ID do aplicativo
6️⃣ Utilize o fluxo de autenticação OAuth2 para obter o token de acesso e consumir os endpoints da API da Yampi
🔗 Ver artigo oficial
🛠️ Como acessar o Painel do Parceiro?
🛠️ Como acessar o Painel do Parceiro?
O Painel do Parceiro está disponível em:
🔗 Acessar Painel do Parceiro
No painel, você pode:
• Registrar e gerenciar seus aplicativos
• Acompanhar integrações
• Acessar recursos exclusivos para desenvolvedores
🔄 Como funciona a URL de redirecionamento?
🔄 Como funciona a URL de redirecionamento?
A URL de redirecionamento é o endereço para o qual o usuário será enviado após autorizar o acesso do seu aplicativo.
Durante a configuração do aplicativo no Painel do Parceiro, você deve especificar essa URL.
Após a autorização, a Yampi redirecionará o usuário para essa URL com um código de autorização temporário, que você usará para obter o token de acesso.
🔗 Ver fluxo de autenticação
📚 Onde encontro a documentação da API?
📚 Onde encontro a documentação da API?
A documentação oficial da API da Yampi está disponível no link abaixo:
🔗 Acessar documentação da API
Lá você encontrará informações detalhadas sobre:
• Autenticação
• Endpoints disponíveis
• Parâmetros
• Exemplos de requisições
• E muito mais!
⏱️ Como funciona o rate-limit dos endpoints?
⏱️ Como funciona o rate-limit dos endpoints?
A API da Yampi possui limites de requisições para garantir a estabilidade do serviço.
Se você exceder o número permitido de requisições em um determinado período, receberá uma resposta com o código de status HTTP 429
(Too Many Requests).
Para evitar esse problema:
• Implemente mecanismos de controle de taxa (rate limit) no seu aplicativo
• Consulte os cabeçalhos de resposta para verificar os limites atuais
Endpoints mais utilizados e seus limites:
GET https://api.dooki.com.br/v2/{alias}/orders
→ 120 requisições/minPUT https://api.dooki.com.br/v2/{alias}/orders
→ 30 requisições/minGET https://api.dooki.com.br/v2/{alias}/catalog/products
→ 30 requisições/min
🤝 Quais plataformas integramos?
🤝 Quais plataformas integramos?
A Yampi oferece integração com diversas plataformas e serviços, incluindo:
• ERPs (como Bling, Tiny, Omie)
• Gateways de pagamento (como Mercado Pago, PagSeguro, Pagar.me)
• Plataformas de e-commerce (como Shopify, WooCommerce)
• Ferramentas de marketing e automação
• Aplicativos de logística e frete
🔗 Ver integrações disponíveis
🧪 Minha conta de testes tem algum custo?
🧪 Minha conta de testes tem algum custo?
Não, sua conta é totalmente gratuita, mesmo se gerar pedidos!
🔗 Ver mais sobre loja de testes
📘 Quais os principais retornos HTTP da API da Yampi?
📘 Quais os principais retornos HTTP da API da Yampi?
A API da Yampi segue os padrões REST e utiliza códigos HTTP para indicar o resultado das requisições.
Principais códigos de resposta:
- 🟢
200 OK
: Requisição bem-sucedida - 🟢
201 Created
: Recurso criado com sucesso - 🟢
204 No Content
: Requisição bem-sucedida, sem corpo - 🔴
400 Bad Request
: Erro no payload - 🔴
401 Unauthorized
: Token ausente ou inválido - 🔴
403 Forbidden
: Acesso negado - 🔴
404 Not Found
: Recurso inexistente - 🔴
429 Too Many Requests
: Limite excedido - 🟡
500 Internal Server Error
: Erro interno no servidor
🔁 Minha autenticação OAuth2 expira por inatividade do Lojista?
🔁 Minha autenticação OAuth2 expira por inatividade do Lojista?
Não, o refresh_token
tem validade de 30 dias. Enquanto estiver válido, você pode usá-lo para renovar o access_token
sempre que necessário — lembrando que o access_token
expira após 10 minutos.
O processo completo de autenticação só será necessário se o aplicativo não renovar os tokens antes do vencimento do refresh_token
.
Ao atualizar o access_token
, fazendo a chamada para /oauth/token
, você também receberá um novo refresh_token
.
Essa chamada de atualização é feita da seguinte forma:
Ao executá-la com sucesso, ambos seus tokens serão atualizados automaticamente.