API Produtos - VOCÊ
Conecte-se ao nosso catálogo, personalize sua vitrine e transforme cada navegação em uma oportunidade de venda com a API de Produtos da VOCÊ.
📌 Visão Geral
A API de Produtos da VOCÊ tem como principal objetivo oferecer acesso estruturado, seguro e em tempo real ao nosso catálogo de produtos. Parceiros e divulgadores podem integrar os dados de produtos diretamente em seus próprios sites, sistemas ou plataformas, proporcionando ao consumidor final uma navegação fluida, com possibilidade de explorar os produtos, adicioná-los ao carrinho e concluir a compra diretamente em nosso checkout.
Essa integração visa criar experiências de compra conectadas, ampliando o alcance da nossa plataforma e gerando novas oportunidades de conversão para nossos parceiros.
👥 Quem pode utilizar a API?
- Ter um cadastro ativo e aprovado.
- Estar autorizado a gerar credenciais de acesso.
- Seguir as políticas de uso estabelecidas em contrato.
🎯 Principais casos de uso
- Exibição personalizada do catálogo de produtos: Permite que parceiros integrem campanhas e coleções ao seu ambiente digital, criando feeds personalizados com base em categorias, promoções ou preferências de público.
- Criação de experiências de descoberta e navegação: Utilizando os dados fornecidos pela API, é possível montar páginas com filtros, recomendações, vitrines dinâmicas e destaques adaptados ao perfil do usuário final.
- Integração com carrinho de compras externo: A jornada do cliente pode começar no site ou app do parceiro e ser finalizada de forma transparente e segura em nosso sistema de checkout, mantendo a consistência da experiência de compra.
❓ Perguntas Frequentes (FAQ)
-
Erro 401 Unauthorized: Verifique se o token está sendo enviado corretamente como
Authorization: Bearer {seu_token}e se está ativo e válido. - Erro 403 Forbidden: Confirme se sua conta tem acesso ao endpoint e se há campanhas ou produtos habilitados.
- Erro 404 Not Found: O identificador (ID ou slug) do produto pode não existir ou ter sido desativado. Endpoints são sensíveis a maiúsculas/minúsculas.
- Erro 429 Too Many Requests: Consulte a seção de Rate Limits e implemente mecanismos de retry com backoff.
- Catálogo vazio: Verifique se o parceiro tem campanhas ou produtos habilitados e se os filtros aplicados não retornam zero resultados.
- Erro 400 Bad Request: Parâmetros obrigatórios ausentes, estrutura JSON incorreta ou headers inválidos.
- Como testar a API? Utilizando o ambiente de sandbox com dados simulados. Solicite acesso ao time técnico.
🧾 Estrutura de Códigos de Erro
Formato de resposta:
{
"status": 403,
"code": "ACCESS_DENIED",
"message": "Você não tem permissão para acessar este recurso."
}
| HTTP | Código Interno | Descrição |
|---|---|---|
| 400 | INVALID_REQUEST | Requisição malformada. |
| 401 | UNAUTHORIZED | Token inválido ou ausente. |
| 403 | ACCESS_DENIED | Sem permissão. |
| 404 | RESOURCE_NOT_FOUND | Recurso inexistente. |
| 429 | RATE_LIMIT_EXCEEDED | Limite excedido. |
| 500 | INTERNAL_ERROR | Erro interno no servidor. |
🩺 Endpoint de Health Check
Requisição: GET /v1/health
Resposta de sucesso:
{
"status": "ok",
"timestamp": "2025-05-19T14:33:00Z",
"version": "1.2.0"
}
Status possíveis:
ok: API operacional.degraded: Funcionalidade limitada.down: API indisponível.