Consultoria técnica
Não sabe por onde começar? Agende uma sessão individual com um especialista em API e integração por apenas 79 dólares.
A API da ActiveCampaign é usada para permitir integrações entre sua conta ActiveCampaign e serviços de terceiros ou uma interface personalizada criada.
O que é uma API?
A API é abreviação de Interface de Programação de Aplicativos. Ela permite que um app converse com outro. Recomendamos usar a API da ActiveCampaign para conectar todas as funcionalidades fora da interface principal do usuário, como para fazer uma integração.
Como obter seu URL e sua chave da API ActiveCampaign
Para ativar uma integração entre sua conta ActiveCampaign e um app de terceiros, é necessário obter sua URL e chave de API. A URL e a chave da API podem ser consideradas seu nome de usuário e senha, que apps de terceiros podem usar para acessar sua conta da ActiveCampaign.
Cada usuário em sua conta ActiveCampaign tem sua própria URL e chave da API.
Se as integrações forem configuradas com as credenciais de API de um usuário, excluir o usuário fará com que as integrações sejam interrompidas. Como não há API padrão da conta, é necessário atualizar as integrações afetadas com as credenciais de API de outro usuário.
Sua URL e chave da API da ActiveCampaign estão localizadas na página Configurações do desenvolvedor em sua conta:
- Clique em "Configurações" (ícone de engrenagem) no menu do lado esquerdo.
- O menu Configurações da conta será exibido. Clique na opção "Desenvolvedor".
- Copie e cole a URL e a chave da API em seu app de terceiros.
Como redefinir suas informações de API
Se suas informações de API tiverem sido comprometidas, será possível redefinir sua chave na página Configurações do desenvolvedor da sua conta.
Para redefinir as informações da API:
- Clique em "Configurações" (ícone de engrenagem) no menu do lado esquerdo.
- O menu Configurações da conta será exibido. Clique na opção "Desenvolvedor".
- Navegue até a página Configurações do desenvolvedor.
- Clique no botão "Redefinir chave de API".
- Uma janela de confirmação aparecerá. Clique em "Redefinir chave de API" para confirmar a alteração.
Observe que será necessário atualizar todos os apps de terceiros com suas novas informações de API.
API para Desenvolvedores
Com a API ActiveCampaign, é possível sincronizar informações de contato, visualizar informações de contato, adicionar contatos a automações, criar e enviar campanhas e muito mais. Nossa API está estruturada em torno de REST, HTTP e JSON e requer autenticação básica (conta de usuário real dentro do software ou uma URL e chave de API válidas).
Acesse o portal de Desenvolvedor da ActiveCampaign.
Para trabalhar com nossa API, você precisará do seguinte:
- Conta ActiveCampaign válida (uma versão de teste também funcionará)
- Experiência na criação de soluções de código personalizadas e/ou integração com APIs REST
- Capacidade de enviar solicitações HTTP do seu servidor
Fornecemos uma lista de métodos de API disponíveis, descrições detalhadas de cada parâmetro e exemplos em código real. Nosso fórum comunitário é um grande recurso, pois você está aprendendo como a API funciona. Lá, é possível interagir com outros desenvolvedores e fazer perguntas sobre a API. Além disso, temos consultores certificados que podem ajudar você com os requisitos de sua API.
Solução de problemas da API para Desenvolvedores
Se estiver recebendo erros de script, dados ausentes ou qualquer coisa que o proíba de usar totalmente a API, entre em contato com nossa Equipe de Experiência do Cliente e forneça as informações a seguir:
- URL de solicitação de API completa (incluindo todos os parâmetros)
- Se for uma solicitação POST, seus dados POST serão necessários
- A resposta/ação esperada
- A resposta real recebida do servidor e a ação realizada (se houver)
Observe que, embora façamos nosso melhor para ajudar na solução dos problemas com a API, isso pode ser desafiador. Isso ocorre porque não podemos ver o que está acontecendo com seu app, script ou ambiente.
Se tiver uma pergunta mais geral (por exemplo, como funciona um método de API específico ou por que uma API específica não está retornando dados), recomendamos que publique o problema em nosso fórum de usuários, onde ele é documentado publicamente. Dessa forma, outros usuários podem ajudar, compartilhar suas próprias experiências e ajudar futuros usuários a aprender com experiências passadas.
Se você precisar de ajuda para configurar algo usando a API, recomendamos trabalhar com um de nossos consultores certificados ou postar em nosso fórum da comunidade.