Saltar para o conteúdo principal
O Topsort usa dois tipos de chaves API para diferentes propósitos.

Referência Rápida

Tipo de ChaveOndePropósitoUsuário
Marketplace API KeyConfigurações de AdminTodas as operações do marketplaceServidores backend
Advanced API KeyPainel do VendedorCampanhas de um único vendedorFerramentas do vendedor

Qual Chave Eu Preciso?

EndpointTipo de Chave
POST /v2/auctionsMarketplace
POST /v2/eventsMarketplace
POST /v2/productsMarketplace
GET /public/v1/reporting-service/*Marketplace
POST /public/v1/campaign-service/*Qualquer uma (com escopo de vendedor se for chave Advanced)
GET /public/v1/billing-service/*Marketplace

Erros Comuns

401 Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key"
}
Causas:
  • 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"
}
Causas:
  • Usando chave Advanced para endpoint que requer chave Marketplace
  • Chave Advanced tentando acessar dados de vendedor diferente
Correção: Use chave API Marketplace para operações entre vendedores

Como Obter Suas Chaves

Marketplace API Key

1

Acessar o Topsort Admin

Faça login no seu painel de administração do Topsort
2

Navegar para Configurações de API

Vá para ConfiguraçõesIntegração de API
3

Criar Chave API

Clique em “Gerar chave API” e selecione “Marketplace API key”
4

Copiar e Armazenar

Copie a chave imediatamente e armazene-a com segurança (é mostrada apenas uma vez)

Advanced API Key

1

Acessar o Painel do Vendedor

Faça login no seu Painel de Administração do Topsort
2

Navegar para Configurações de API

Vá para ConfiguraçõesAcesso à API
3

Gerar Chave

Clique em “Gerar Chave” para criar sua chave Advanced API
4

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

Escopo de Permissões de Chave

Marketplace API Key

  • Acesso completo a todas as operações do marketplace
  • Pode criar e gerenciar campanhas para qualquer vendedor
  • Acesso a todos os dados de relatórios
  • Obrigatória para endpoints de leilão e evento

Advanced API Key

  • Limitada aos dados de um vendedor específico
  • Pode apenas gerenciar campanhas para o vendedor associado
  • Não pode acessar informações de outros vendedores
  • Ideal para integrações específicas de vendedor
Last updated: