Sobre chaves de API

Neste artigo, abordaremos o que é uma API e como gerar uma chave de API para conceder acesso à sua conta do Mailchimp. Também abordaremos onde obter suporte com perguntas sobre a API de marketing do Mailchimp .

O que é uma API?

API significa application programming interface (interface de programação de aplicativo). Pense na API como uma forma para que vários aplicativos diferentes conversem. Você envia e recebe dados entre aplicativos usando solicitações e respostas de API. Uma chave de API é uma série única de caracteres incluídos em uma solicitação para verificar se o sistema solicitante tem permissão para se comunicar com o sistema receptor.

Gerar uma chave de API

Muitas vezes, você precisará gerar uma chave de API ao configurar uma integração com sua conta do Mailchimp. Os usuários que têm permissões de gerente podem gerar suas próprias chaves de API. Os usuários com permissões de administrador também podem ver as chaves de API que outros usuários da conta geraram.

Para gerar uma chave de API, siga estas etapas:

1. Clique no ícone do seu perfil e escolha Profile (Perfil).
2. Clique no menu suspenso Extras e escolha Chaves de API.
3. Na seção Suas chaves de API, clique em Criar uma chave.
4. Dê um nome à sua chave. Seja descritivo, assim você pode saber por qual aplicativo a chave é usada. Lembre-se de que você verá apenas esse nome e os primeiros quatro dígitos em sua lista de chaves de API.
5. Clique em Generate Key (Gerar chave).
6. Depois de gerar sua chave, clique em Copy Key to Clipboard (Copiar chave para a área de transferência). Salve sua chave em algum lugar seguro; você não poderá vê-la ou copiá-la novamente. Se você perder essa chave, precisará gerar uma nova chave e atualizar qualquer integração que a use.
7. Clique em Done (Concluído).

Revogar uma chave de API

Se uma chave de API foi comprometida ou você não usa mais a integração que acessava a conta por meio dela, é possível revogar essa chave de API. Depois de revogar uma chave de API, ela não pode ser reativada. Você precisará gerar uma nova chave e atualizar quaisquer integrações que usam a chave original.

Para revogar uma chave de API, siga estas etapas:

1. Clique no ícone do seu perfil e escolha Profile (Perfil).
2. Clique no menu suspenso Extras e escolha Chaves de API.
3. Encontre a chave de API que deseja revogar e clique em Revoke (Revogar).
4. No modal pop-up, digite REVOKE e depois clique em Revogar para confirmar sua ação.

Segurança da chave de API

As chaves de API concedem acesso total à sua conta do Mailchimp. Você deve protegê-las da mesma forma que protegeria sua senha. Tenha em mente estes cenários comuns ao trabalhar com chaves de API.

• Dê a cada integração sua própria chave de API. Atribua nomes descritivos a cada chave para saber qual chave vai com qual aplicativo. Se uma chave de API específica for comprometida, você poderá revogá-la sem desativar o acesso às suas outras integrações.
• Tenha cuidado para não expor a chave ao público (como em capturas de tela, vídeos ou documentos de ajuda). Vale lembrar que desfocar os dados nem sempre é o suficiente. É melhor remover os dados completamente.
• Devido aos possíveis riscos de segurança associados à exposição das chaves de API da conta, o Mailchimp não aceita a implementação da nossa API pelo cliente usando solicitações CORS ou incluindo chaves de API em aplicativos móveis.
• Se precisar compartilhar o acesso à sua conta, gere uma nova chave e nomeie-a para saber qual chave revogar, se necessário. Nunca envie uma chave de API por e-mail. Caso a conta de e-mail seja invadida por hackers, eles poderão acessar também a conta do Mailchimp.
• Se você revogar o acesso de um usuário à sua conta do Mailchimp, removeremos da sua conta quaisquer chaves de API criadas por ele.
• O acesso a cada terminal é determinado pela função do usuário que gerou a chave de API. Para saber mais sobre os níveis de permissão de usuário, confira Gerenciar níveis de usuário em sua conta.

Suporte a APIs

Nossa equipe de suporte do Mailchimp não possui um treinamento detalhado sobre a solução de problemas de APIs. Se precisar da ajuda de um desenvolvedor para fazer uma configuração usando a API, confira a nossa Lista de Especialistas. Ela traz indicações de especialistas externos do Mailchimp que você pode contratar.

Se você é desenvolvedor e quer construir uma integração com o Mailchimp, confira a nossa documentação de API.