A API 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 Application Programming Interface e permite que um aplicativo converse com outro. Recomendamos o uso da API ActiveCampaign para qualquer funcionalidade necessária fora da interface principal do usuário, como permitir uma integração.
Como obter seu URL e sua chave da API ActiveCampaign
Para ativar uma integração entre sua conta ActiveCampaign e um aplicativo de terceiros, você precisa 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, você deve atualizar as integrações afetadas com as credenciais de API de outro usuário.
O URL e a chave da API da ActiveCampaign estão localizados na página Configurações do desenvolvedor em sua conta:
- Clique em "Configurações" (ícone de engrenagem) no menu esquerdo.
- O menu Configurações da conta será exibido. Clique na opção "Desenvolvedor".
- Copie e cole sua URL e chave de API em seu aplicativo de terceiros.
Como redefinir suas informações de API
Se suas informações de API tiverem sido comprometidas, você poderá 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 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 você deve atualizar todos os aplicativos de terceiros com suas novas informações de API.
API para Desenvolvedores
Com a API ActiveCampaign, você pode 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 key de API válidas).
Acesse o portal ActiveCampaign Developer.
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 da comunidade é um ótimo recurso à medida que você aprende 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 necessidades de API.
Solução de problemas da API para Desenvolvedores
Se você 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 seguintes informações:
- 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)
Embora façamos o nosso melhor para ajudá-lo a solucionar problemas de API, isso pode fornecer certos desafios. Isso ocorre porque não podemos ver o que está acontecendo com seu aplicativo, script ou ambiente.
Se você tiver uma pergunta mais geral (como como um método de API específico funciona ou por que uma API específica não está retornando dados), recomendamos postar 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.