Saltar para o conteúdo principal
As chaves API permitem o acesso seguro e programático à plataforma unificada de meios varejistas da Toppie. Seja automatizando a gestão de campanhas, criando painéis personalizados ou integrando dados da Toppie em fluxos de trabalho existentes, as chaves API fornecem a base para escalar as operações de meios varejistas além da interface de usuário.
As chaves Toppie de API fornecem autenticação segura baseada em tokens para o acesso programático a todos os endpoints Toppie. Isto permite a automação da gestão de campanhas, a integração de dados e os fluxos de trabalho de relatórios personalizados.

Benefícios chave

Automatizar as operações de campanha

Crie fluxos de trabalho que criem, gerenciem e otimizem campanhas em múltiplos varejistas sem intervenção manual

Integrações personalizadas

Conecte os dados da Toppie a ferramentas de BI, painéis de relatórios ou sistemas internos para obter análises unificadas de meios varejistas

Controle de acesso seguro

As permissões baseadas em funções garantem que os membros da equipe só acessem os dados e as funcionalidades que necessitam

Criando chaves API

1

Navegue a Configurações

Acesse Ajustes na navegação do painel de controle da Toppie
2

Selecione Integração API

Selecione Integração API no menu de navegação da esquerda
3

Criar nova chave

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

Salve imediatamente

Copie e salve sua chave API imediatamente - ela só será exibida uma vez por motivos de segurança
5

Armazenamento seguro

Armazene sua chave API em um local seguro, como um gerenciador de senhas ou um sistema de gestão de segredos
Toppie API Integration interface showing the New API Key button

Usando as chaves API

Inclua sua chave API nos cabeçalhos de solicitação para a autenticação ao realizar chamadas à API Toppie.

Cabeçalho de autenticação

curl -X GET https://api.topsort.com/toppie/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Pontos de conexão API disponíveis

Acesse a funcionalidade completa através da API Toppie:
  • Gestão de catálogo de produtos - Carregar, atualizar e gerenciar catálogos de produtos
  • Operações do ciclo de vida da campanha - Criar, modificar e supervisionar campanhas
  • Análises e relatórios avançados - Acesse dados de desempenho detalhados
  • Gestão de orçamentos e lances - Alocação e otimização programática do orçamento

Documentação de API

Para obter a documentação de referência completa de API, visite a Referência da API Toppie. A documentação inclui:
  • Especificações e parâmetros do ponto final
  • Exemplos de solicitação/resposta
  • Diretrizes para o tratamento de erros
  • Informação de limitação de velocidade
  • Exemplos de SDK em vários idiomas

Melhores práticas de segurança

Diretrizes de segurança
  • Nunca compartilhe as chaves API em repositórios de código nem em canais públicos
  • Rotacione as chaves regularmente para maior segurança
  • Utilize variáveis de ambiente ou cofres seguros para armazenar as chaves
  • Supervisione o uso de API para detectar qualquer atividade inusual
  • Implemente controles de acesso adequados em suas aplicações

Gestão de chaves

  • Regeneração - Rotacione as chaves API periodicamente ou quando os membros da equipe saiam
  • Monitoramento - Rastreie os padrões de uso de API e configure alertas para atividade inusual
  • Controle de acesso - Limite o acesso à chave API unicamente aos membros da equipe que o necessitem
  • Armazenamento de backup - Guarde as chaves em múltiplas localizações seguras com controles de acesso adequados

Casos de uso comuns

Automação de campanhas

Automatize a criação de campanhas, os ajustes de orçamento e a otimização do desempenho em função de regras e acionadores predefinidos.

Integração de relatórios

Incorpore os dados de desempenho da Toppie às ferramentas de inteligência empresarial existentes ou aos painéis personalizados para obter relatórios unificados.

Gestão de inventários

Sincronize automaticamente os catálogos de produtos e mantenha atualizado o inventário em todos os parceiros varejistas.

Otimização orçamentária

Implemente algoritmos personalizados de alocação orçamentária baseados em métricas de desempenho e objetivos empresariais.

Para obter ajuda com a integração de API ou para discutir casos de uso avançados de gestão de campanhas programáticas, entre em contato com seu gerente de conta da Toppie.

Última atualização: