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

# Gestão de chaves de API

> Acesso programático para gerenciar campanhas e análises em redes de meios varejistas

export const LastUpdatedPt = ({date}) => {
  const label = "Última atualização:";
  return <>
      <style>{`
        .last-updated-component {
          display: inline-flex;
          align-items: center;
          gap: 8px;
          padding: 10px 16px;
          border-radius: 8px;
          margin-top: 12px;
          margin-bottom: 16px;
          font-size: 14px;
          background-color: rgba(0, 0, 0, 0.05);
          border: 1px solid rgba(0, 0, 0, 0.12);
          color: rgba(0, 0, 0, 0.75);
          line-height: 1;
        }

        .last-updated-component svg {
          flex-shrink: 0;
          vertical-align: middle;
        }

        .last-updated-component span {
          display: inline-flex !important;
          align-items: center !important;
          line-height: 1 !important;
        }

        [data-theme="dark"] .last-updated-component {
          background-color: #3a3a3a;
          border: 2px solid #888888;
          color: #ffffff;
        }

        [data-theme="dark"] .last-updated-component svg {
          stroke: #ffffff;
        }
      `}</style>
      <div className="last-updated-component">
        <svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
          <circle cx="12" cy="12" r="10" />
          <polyline points="12 6 12 12 16 14" />
        </svg>
        <span>
          <strong style={{
    fontWeight: 600
  }}>{label}</strong> 
          <time dateTime={date}>{date}</time>
        </span>
      </div>
    </>;
};

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

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  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.
</div>

## Benefícios chave

<Columns cols={3}>
  <Card title="Automatizar as operações de campanha">
    Crie fluxos de trabalho que criem, gerenciem e otimizem campanhas em múltiplos varejistas sem intervenção manual
  </Card>

  <Card title="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
  </Card>

  <Card title="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
  </Card>
</Columns>

## Criando chaves API

<Steps>
  <Step title="Navegue a Configurações">
    <div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
      Acesse **Ajustes** na navegação do painel de controle da Toppie
    </div>
  </Step>

  <Step title="Selecione Integração API">
    <div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
      Selecione **Integração API** no menu de navegação da esquerda
    </div>
  </Step>

  <Step title="Criar nova chave">
    <div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
      Clique no botão **"+ Nova chave API"** para gerar uma nova chave
    </div>
  </Step>

  <Step title="Salve imediatamente">
    <Warning>
      Copie e salve sua chave API imediatamente - ela só será exibida uma vez por motivos de segurança
    </Warning>
  </Step>

  <Step title="Armazenamento seguro">
    <div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
      Armazene sua chave API em um local seguro, como um gerenciador de senhas ou um sistema de gestão de segredos
    </div>
  </Step>
</Steps>

<Frame>
  <img src="https://mintcdn.com/topsort/uSrfRB5jaD2RxnFe/images/knowledge-base/creating-toppie-api-keys.webp?fit=max&auto=format&n=uSrfRB5jaD2RxnFe&q=85&s=7096cf2ddd962b839c008ff32ce7fa07" alt="Toppie API Integration interface showing the New API Key button" width="2887" height="664" data-path="images/knowledge-base/creating-toppie-api-keys.webp" />
</Frame>

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

```bash theme={null}
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](/pt/api-reference/toppie-api/%5Bbeta%5D-get-toppie-campaigns).

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

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

### Gestão de chaves

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  * **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
</div>

## Casos de uso comuns

### Automação de campanhas

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  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.
</div>

### Integração de relatórios

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  Incorpore os dados de desempenho da Toppie às ferramentas de inteligência empresarial existentes ou aos painéis personalizados para obter relatórios unificados.
</div>

### Gestão de inventários

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  Sincronize automaticamente os catálogos de produtos e mantenha atualizado o inventário em todos os parceiros varejistas.
</div>

### Otimização orçamentária

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  Implemente algoritmos personalizados de alocação orçamentária baseados em métricas de desempenho e objetivos empresariais.
</div>

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  ***
</div>

<div style={{textAlign: 'justify', marginBottom: '1.5rem'}}>
  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.
</div>

***

<LastUpdatedPt date="2025-11-18" />