Saltar para o conteúdo principal
A API do Toppie permite acesso programático seguro à plataforma unificada de retail media da Topsort. Seja automatizando o gerenciamento de campanhas, criando dashboards personalizados ou integrando dados do Toppie em fluxos de trabalho existentes, a API fornece a base para escalar operações de retail media além da interface do usuário.
A API do Toppie fornece endpoints públicos para gerenciar e analisar contas de agências, campanhas e atividade financeira em vários parceiros varejistas.

Referência da API do Toppie

Visualize a documentação completa da API com todos os endpoints disponíveis

​
Benefícios Principais

  • Automatizar Operações de Campanha - Crie fluxos de trabalho para gerenciar campanhas em varejistas sem intervenção manual
  • Integrações Personalizadas - Conecte dados do Toppie a ferramentas de BI e sistemas internos
  • Controle de Acesso Seguro - Permissões baseadas em funções para dados e capacidades

​
Capacidades da API

A API do Toppie fornece funcionalidade abrangente através dos seguintes endpoints:
Carregue, atualize e gerencie catálogos de produtos em parceiros varejistas. Mantenha o inventário sincronizado e garanta informações precisas de produtos para suas campanhas.
Crie, modifique, pause e exclua campanhas programaticamente. Defina orçamentos, parâmetros de segmentação e estratégias de lance para Listings Patrocinados e Banners.
Recupere dados de desempenho em tempo real incluindo impressões, cliques, conversões, métricas de ROAS e gastos com anúncios. Gere relatórios personalizados com intervalos de datas e seleções de métricas específicas.
Acompanhe saldos de contas, visualize histórico de transações e gerencie faturamento programaticamente. Implemente algoritmos personalizados de alocação de orçamento baseados em métricas de desempenho.

​
Autenticação

Todas as solicitações da API do Toppie requerem autenticação usando chaves de API com autenticação baseada em token. Isso garante acesso seguro às suas campanhas e dados.

​
Obtendo sua Chave de API

1

Navegar para Configurações

Acesse Configurações na navegação do seu dashboard do Toppie
2

Selecionar Integração de API

Escolha Integração de API no menu de navegação esquerdo
3

Criar Nova Chave

Clique no botão ”+ Nova Chave de API” para gerar uma nova chave
4

Salvar Imediatamente

Copie e salve sua chave de API imediatamente—ela será exibida apenas uma vez por razões de segurança

​
Usando sua Chave de API

Inclua sua chave de API no cabeçalho Authorization de cada solicitação: 
curl -X GET "https://api.topsort.com/toppie/v1/campaigns" \
  -H "Authorization: Bearer SUA_CHAVE_API" \
  -H "Content-Type: application/json"

​
Melhores Práticas de Segurança

Diretrizes de Segurança:
  • Nunca compartilhe chaves de API em repositórios de código ou canais públicos
  • Rotacione as chaves regularmente para maior segurança
  • Use variáveis de ambiente ou cofres seguros para armazenar chaves
  • Monitore o uso da API para detectar atividades incomuns
  • Implemente controles de acesso apropriados em suas aplicações

​
Casos de Uso Comuns

Automatize a criação de campanhas, ajustes de orçamento e otimização de desempenho com base em regras e gatilhos predefinidos. Crie fluxos de trabalho que respondam a limites de desempenho ou condições de mercado.Cenários de exemplo:
  • Pausar automaticamente campanhas quando o ROAS cair abaixo da meta
  • Criar novas campanhas com base em atualizações do catálogo de produtos
  • Ajustar lances dinamicamente com base na hora do dia ou níveis de inventário

​
Documentação da API

Para documentação completa de referência da API incluindo especificações de endpoints, parâmetros, exemplos de solicitação/resposta e diretrizes de tratamento de erros, visite a Referência da API do Toppie.

Precisa de ajuda com sua integração Topsort?

Fale conosco, a equipe de engenharia de integrações.Entre em contato através do seu canal de mensagens dedicado ou em support@topsort.com.Se você ainda não é cliente, agende uma demo com nossa equipe de vendas.