As chaves API permitem interagir com o Middlewr de forma programática — criar links, consultar analytics ou gerenciar seu workspace pela API. Cada chave possui um nível de permissões que controla o que ela pode acessar. Este guia aborda a criação, o uso e a exclusão de chaves API.

Pré-requisitos

Uma conta Middlewr
O papel de Admin no workspace (o gerenciamento de chaves API é restrito a administradores)

Passo 1: Acessar as chaves API

Vá até Configurações pela barra lateral e clique na aba Chaves API. Essa página lista todas as chaves API existentes do workspace, exibindo nome, prefixo, nível de permissões, data de último uso e data de criação.

Se ainda não houver nenhuma chave, você verá um estado vazio convidando a criar a primeira.

Página de configurações de Chaves API

Passo 2: Criar uma chave API

Clique em Criar chave API. Um modal aparecerá com dois campos:

Nome — um rótulo descritivo para identificar esta chave (por exemplo, "Pipeline CI/CD", "Automação de Marketing").
Permissões — selecione o nível de permissões para esta chave no dropdown. Os níveis disponíveis dependem do seu próprio papel — você só pode conceder permissões iguais ou inferiores às suas.

Clique em Criar para gerar a chave.

Modal de criação de chave API

Passo 3: Copiar sua chave

Após a criação, um diálogo exibe sua chave API completa. Esta é a única vez que a chave é mostrada — copie-a imediatamente e armazene-a em local seguro (gerenciador de segredos, variável de ambiente, etc.).

O prefixo da chave (primeiros caracteres seguidos de ...) continuará visível na tabela para identificação, mas a chave completa não poderá ser recuperada novamente.

Chave revelada após criação

Excluir uma chave API

Para remover uma chave, clique no botão de excluir ao lado dela na tabela. Um diálogo de confirmação pedirá que você confirme, avisando que qualquer aplicação usando esta chave perderá o acesso imediatamente. Essa ação não pode ser desfeita.

Boas práticas de segurança

Uma chave por integração — não compartilhe uma mesma chave entre vários serviços. Se uma for comprometida, você pode revogá-la sem afetar as demais.
Permissões mínimas — conceda a cada chave apenas o nível de acesso que ela realmente precisa.
Monitore o uso — a coluna "Último uso" ajuda a identificar chaves inativas que devem ser excluídas.
Rotacione regularmente — crie uma nova chave, atualize sua integração e depois exclua a antiga.

Para ir além

Agora que suas chaves API estão configuradas, aqui estão algumas coisas para explorar em seguida:

Importar e exportar links via CSV — gerencie seus links em massa importando ou exportando arquivos CSV, que combina bem com fluxos de trabalho baseados em API.
Gerenciar faturamento e planos — faça upgrade do seu workspace para desbloquear limites de taxa de API mais altos e recursos adicionais conforme seu uso cresce.
A/B testing com split routing — combine criação de links por API com split routing para automatizar seus fluxos de trabalho de testes A/B.