> ## Documentation Index
> Fetch the complete documentation index at: https://docs.topsort.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API do Toppie

> Integre com o Toppie programaticamente usando nossa API

export const IntegrationsCard1APt = () => {
  return <>
      <style>{`
        .integrations-card-1a-pt {
          display: flex;
          flex-direction: column;
          background-color: #f0f2f4;
          border: 1px solid rgba(0, 0, 0, 0.08);
          border-radius: 12px;
          padding: 1.25rem 1.5rem;
          gap: 0.25rem;
          color: #25253b;
          box-shadow: 0 1px 3px rgba(0, 0, 0, 0.02);
          transition: box-shadow 0.2s ease, border-color 0.2s ease, transform 0.2s ease;
          margin-top: 2rem;
        }

        .integrations-card-1a-pt:hover {
          box-shadow: 0 4px 12px rgba(0, 0, 0, 0.06);
          border-color: rgba(0, 0, 0, 0.12);
        }

        .dark .integrations-card-1a-pt {
          background-color: #25253b;
          color: #f6f8fa;
          border-color: rgba(255, 255, 255, 0.08);
          box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
        }

        .dark .integrations-card-1a-pt:hover {
          box-shadow: 0 4px 12px rgba(0, 0, 0, 0.2);
          border-color: rgba(255, 255, 255, 0.12);
        }

        .integrations-card-1a-pt-avatar-row {
          display: flex;
          margin-left: 14px;
          flex-wrap: wrap;
        }

        .integrations-card-1a-pt-avatar {
          width: 44px;
          height: 44px;
          border-radius: 50%;
          border: 2px solid #f0f2f4;
          margin-left: -14px;
          object-fit: cover;
          box-shadow: 0 2px 6px rgba(0, 0, 0, 0.08);
          pointer-events: none;
          cursor: default;
        }

        .dark .integrations-card-1a-pt-avatar {
          border-color: #25253b;
          box-shadow: 0 2px 8px rgba(0, 0, 0, 0.2);
        }

        .integrations-card-1a-pt h2 {
          margin: 0;
          line-height: 1.25;
          font-size: clamp(1.25rem, calc(0.875rem + 1.25vw), 1.75rem);
          font-weight: 700;
          letter-spacing: -0.025em;
          color: #111827;
        }

        .dark .integrations-card-1a-pt h2 {
          color: #f9fafb;
        }

        .integrations-card-1a-pt-subtitle {
          font-size: 0.9375rem;
          font-weight: 500;
          line-height: 1.5;
          color: #4b5563;
          margin: 0;
        }

        .dark .integrations-card-1a-pt-subtitle {
          color: #d1d5db;
        }

        .integrations-card-1a-pt p {
          margin: 0;
          line-height: 1.5;
          font-size: 0.875rem;
          color: #374151;
        }

        .dark .integrations-card-1a-pt p {
          color: #d1d5db;
        }

        .integrations-card-1a-pt a {
          color: #0500ff;
          text-decoration: none;
          font-weight: 500;
          transition: color 0.15s ease;
        }

        .integrations-card-1a-pt a:hover {
          color: #0400cc;
        }

        .dark .integrations-card-1a-pt a {
          color: #8280ff;
        }

        .dark .integrations-card-1a-pt a:hover {
          color: #a19fff;
        }

        @media (max-width: 640px) {
          .integrations-card-1a-pt-avatar {
            width: 38px;
            height: 38px;
            margin-left: -12px;
          }

          .integrations-card-1a-pt-avatar-row {
            margin-left: 12px;
          }
        }

        @media (min-width: 1280px) {
          .integrations-card-1a-pt p {
            font-size: 0.6875rem;
            line-height: 1.4;
            letter-spacing: -0.01em;
          }

          .integrations-card-1a-pt h2 {
            font-size: clamp(1rem, calc(0.75rem + 1vw), 1.25rem);
          }

          .integrations-card-1a-pt-subtitle {
            font-size: 0.75rem;
          }
        }
      `}</style>
      <div className="integrations-card-1a-pt">
        <div className="integrations-card-1a-pt-avatar-row">
          <img src="/images/integration-team/agustin.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/amelia.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/bernardita.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/borumy.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/felipe.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/gui.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/javiera.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/linn.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/marcio.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/mateus.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/max.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
          <img src="/images/integration-team/rodrigo.webp" alt="" loading="lazy" className="integrations-card-1a-pt-avatar" />
        </div>

        <h2>Precisa de ajuda com sua integração Topsort?</h2>

        <p className="integrations-card-1a-pt-subtitle">
          Fale conosco, a equipe de engenharia de integrações.
        </p>

        <p>
          Entre em contato através do <strong>seu canal de mensagens dedicado</strong> ou em{" "}
          <a href="mailto:support@topsort.com">support@topsort.com</a>.
        </p>

        <p>
          Se você ainda não é cliente,{" "}
          <a href="https://www.topsort.com/book-a-demo">agende uma demo</a> com nossa
          equipe de vendas.
        </p>
      </div>
    </>;
};

<Note>
  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.
</Note>

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.

<Card title="Referência da API do Toppie" icon="book" href="/pt/api-reference/toppie-api/">
  Visualize a documentação completa da API com todos os endpoints disponíveis
</Card>

## 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:

<AccordionGroup>
  <Accordion title="Gerenciamento de Catálogo de Produtos" icon="box">
    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.
  </Accordion>

  <Accordion title="Operações de Ciclo de Vida de Campanha" icon="rectangle-ad">
    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.
  </Accordion>

  <Accordion title="Análise Avançada e Relatórios" icon="chart-line">
    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.
  </Accordion>

  <Accordion title="Gerenciamento de Orçamento e Lances" icon="dollar-sign">
    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.
  </Accordion>
</AccordionGroup>

## 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

<Steps>
  <Step title="Navegar para Configurações">
    Acesse **Configurações** na navegação do seu dashboard do Toppie
  </Step>

  <Step title="Selecionar Integração de API">
    Escolha **Integração de API** no menu de navegação esquerdo
  </Step>

  <Step title="Criar Nova Chave">
    Clique no botão **"+ Nova Chave de API"** para gerar uma nova chave
  </Step>

  <Step title="Salvar Imediatamente">
    <Warning>
      Copie e salve sua chave de API imediatamente—ela será exibida apenas uma vez por razões de segurança
    </Warning>
  </Step>
</Steps>

### Usando sua Chave de API

Inclua sua chave de API no cabeçalho `Authorization` de cada solicitação:

```bash theme={null}
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

<Warning>
  **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
</Warning>

## Casos de Uso Comuns

<Tabs>
  <Tab title="Automação de Campanhas">
    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
  </Tab>

  <Tab title="Integração de Relatórios">
    Extraia dados de desempenho do Toppie para ferramentas de business intelligence existentes ou dashboards personalizados para relatórios unificados em todos os canais de marketing.

    **Cenários de exemplo:**

    * Sincronizar métricas de campanha diárias com Google Sheets ou Excel
    * Alimentar dados em dashboards do Tableau, Looker ou Power BI
    * Agregar desempenho de retail media com outros canais de marketing
  </Tab>

  <Tab title="Gerenciamento de Inventário">
    Sincronize catálogos de produtos automaticamente e mantenha o inventário atualizado em todos os parceiros varejistas, garantindo que as campanhas sempre promovam produtos disponíveis.

    **Cenários de exemplo:**

    * Sincronizar disponibilidade de produtos do seu sistema PIM
    * Atualizar preços e promoções em todas as campanhas
    * Remover produtos esgotados de campanhas ativas
  </Tab>

  <Tab title="Otimização de Orçamento">
    Implemente algoritmos personalizados de alocação de orçamento baseados em métricas de desempenho e objetivos de negócios para maximizar retornos em parceiros varejistas.

    **Cenários de exemplo:**

    * Realocar orçamentos para varejistas com melhor desempenho
    * Implementar algoritmos de ritmo personalizados
    * Coordenar gastos em várias campanhas e varejistas
  </Tab>
</Tabs>

## 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](/pt/api-reference/toppie-api/).

<IntegrationsCard1APt />