O Topsort usa dois tipos de chaves API para diferentes propósitos.
Referência Rápida
| Tipo de Chave | Propósito |
|---|
| Marketplace API Key | Endpoints de leilão e evento |
| Advanced API Key | Sincronização de catálogo, campanhas, relatórios, faturamento |
A maioria das integrações precisa de ambos os tipos de chave: uma chave Advanced para sincronização de catálogo, campanhas e relatórios, e uma chave Marketplace para leilões e eventos.
Qual Chave Eu Preciso?
| Endpoint | Tipo de Chave |
|---|
POST /v2/auctions | Marketplace |
POST /v2/events | Marketplace |
/public/v1/catalog-search-service/* | Advanced |
/public/v1/campaign-service/* | Advanced |
/public/v1/reporting-service/* | Advanced |
/public/v1/billing-service/* | Advanced |
Erros Comuns
401 Unauthorized
{
"error": "Unauthorized",
"message": "Invalid or missing API key"
}
- Chave API não incluída no cabeçalho
Authorization
- A chave está malformada ou expirada
- Usando chave Advanced em endpoint exclusivo do Marketplace
Correção: Verifique o formato do cabeçalho: Authorization: Bearer YOUR_API_KEY
403 Forbidden
{
"error": "Forbidden",
"message": "Insufficient permissions"
}
- Usando uma chave Advanced em um endpoint que requer uma chave Marketplace
- Usando uma chave Marketplace em um endpoint que requer uma chave Advanced
Correção: Use o tipo de chave que corresponde ao endpoint — consulte Qual Chave Eu Preciso? acima
Como Obter Suas Chaves
Marketplace API Key
Acessar o Topsort Admin
Faça login no seu painel de administração do Topsort
Navegar para Configurações de API
Vá para Configurações → Integração de API
Criar Chave API
Clique em “Gerar chave API” e selecione “Marketplace API key”
Copiar e Armazenar
Copie a chave imediatamente e armazene-a com segurança (é mostrada apenas uma vez)
Advanced API Key
Acessar o Topsort Admin
Faça login no seu painel de administração do Topsort
Navegar para Configurações de API
Vá para Configurações → Acesso à API
Gerar Chave
Clique em “Gerar Chave” para criar sua chave Advanced API
Copiar e Armazenar
Copie a chave e armazene-a com segurança em suas variáveis de ambiente
Melhores Práticas de Segurança
- Nunca confirme chaves no controle de versão
- Armazene chaves em variáveis de ambiente
- Rotacione as chaves regularmente
- Use chaves diferentes para diferentes ambientes (dev, staging, produção)
- Restrinja o acesso às chaves apenas aos membros da equipe necessários
