Primeiros passos com a API

A API da ActiveCampaign é utilizada para permitir integrações entre sua conta da ActiveCampaign e serviços de terceiros ou uma interface personalizada criada por você.

Neste artigo, discutiremos:

  • O que é uma API?
  • Como obter sua URL e chave da API
  • Como redefinir suas informações da API
  • API para desenvolvedores
  • Solução de problemas da API

O que é uma API?

API é abreviação de Application Programming Interface (interface de programação de aplicativos) e permite que um aplicativo fale com outro. Recomendamos o uso da API da ActiveCampaign para qualquer funcionalidade necessária fora da interface principal do usuário, como a ativação de uma integração.

Como obter sua URL e chave da API da ActiveCampaign

Para habilitar uma integração entre sua conta da ActiveCampaign e um aplicativo de terceiros, você precisará primeiro obter a URL e a chave da API. A URL e a chave da API podem ser vistas como o nome de usuário e senha para sua conta da ActiveCampaign. Ao fornecer essas informações a um aplicativo de terceiros, ele poderá acessar sua conta para sincronizar informações ou executar outras tarefas.

Para obter a URL e a chave da sua API da ActiveCampaign, siga estas etapas:

1. Clique na opção "Configurações", localizada no menu de navegação lateral esquerdo.


2. O menu "Configurações da conta" será exibido. Clique na opção "Desenvolvedor".


A página "Configurações do desenvolvedor" será carregada e exibirá a URL e a chave da API da sua campanha na ActiveCampaign. Você pode copiar e colar essas informações em seu aplicativo de terceiros.


Como redefinir suas informações da API

No caso de as informações da API terem sido comprometidas, você poderá redefinir sua chave.

Para redefinir suas informações da API, clique no botão "Redefinir" localizado na página "Configurações do desenvolvedor" da sua conta.


Uma janela de confirmação será exibida. Clique em "Reenviar chave da API" para confirmar a alteração.


Note que você precisará atualizar todos os aplicativos de terceiros com as novas informações da API.

API para desenvolvedores

Com a API da ActiveCampaign, você pode sincronizar informações de contato, exibir informações de contato, adicionar contatos a automações, criar e enviar campanhas e muito mais. Nossa API é estruturada em torno de REST, HTTP e JSON e requer autenticação básica (conta de usuário real no software ou uma URL e uma chave de API válidas).

Acesse o portal do desenvolvedor da ActiveCampaign.

Para trabalhar com nossa API, você precisará do seguinte:

  1. Conta válida da ActiveCampaign (uma versão de avaliação também funcionará).
  2. Experiência com criação de soluções personalizadas e/ou integração com APIs REST.
  3. Possibilidade de enviar solicitações HTTP do seu servidor.

Fornecemos uma lista de métodos de API disponíveis, além de descrições detalhadas de cada parâmetro, além de exemplos em código real. Nosso fórum da comunidade é um ótimo recurso para você aprender como a API funciona. Lá, você pode interagir com outros desenvolvedores e fazer perguntas sobre a API. Além disso, temos consultores certificados que podem ajudá-lo com suas dúvidas de API.

Solução de problemas da API para desenvolvedores

Se você estiver recebendo erros de script, dados ausentes ou algo que o impeça de utilizar totalmente a API, entre em contato com nossa equipe de suporte e forneça as seguintes informações:

  1. URL de solicitação da API completa (incluindo todos os parâmetros)
  2. Se for uma solicitação POST, seus dados POST
  3. A resposta/ação esperada
  4. A resposta real recebida do servidor e a ação executada (se houver)

Tenha em mente que, embora façamos o possível para ajudá-lo a resolver seus problemas de API, pode ser um pouco difícil. Isso ocorre porque não conseguimos visualizar o que está acontecendo com seu aplicativo, script ou ambiente.

Se você tiver uma pergunta mais geral (como por exemplo, como um método de API específico funciona ou por que uma API específica não está entregando dados), recomendamos postar o problema em nosso fórum de usuários, onde ele é documentado publicamente para que outros usuários possam ajudar, compartilhar suas próprias experiências e ajudar futuros usuários a aprender com as experiências passadas.

Se você precisar de ajuda para configurar algo utilizando a API, recomendamos entrar em contato com um de nossos consultores certificados ou postar em nosso fórum da comunidade.

Tem mais dúvidas? Envie uma solicitação