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 ActiveCampaign é usada para permitir integrações entre sua conta da ActiveCampaign e serviços de terceiros ou uma interface personalizada criada.
O que é uma API?
A API é abreviação de Application Programming Interface (Interface de programação de aplicações) e permite que um app se comunique 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 a URL e a chave da API ActiveCampaign
Para permitir uma integração, entre sua conta da ActiveCampaign e um app de terceiros, você precisará primeiro obter a URL e a chave da API. A URL e a chave da API podem ser consideradas como o nome de usuário e a senha que apps de terceiros podem usar para acessar a sua conta da ActiveCampaign.
Cada usuário em sua conta da 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 da API de outro usuário.
A URL e a chave da API ActiveCampaign estão localizadas 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 a URL e a chave da API em seu aplicativo de terceiros.
Como redefinir suas informações de API
Se as informações da API foram comprometidas, você pode redefinir a chave na página de Configurações do desenvolvedor na 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 a chave da API" para confirmar a alteração.
Observe que você precisará atualizar todos os aplicativos de terceiros com as 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 chave de API válidas).
Acesse o portal de Desenvolvedor da ActiveCampaign.
Para trabalhar com nossa API, você precisará do seguinte:
- Uma conta válida na ActiveCampaign (a 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 ótimo recurso para você aprender melhor 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 ajudar você com suas necessidades de API.
Solução de problemas de API para Desenvolvedores
Se você se deparar com erros de script, dados ausentes ou qualquer coisa que impeça a utilização da 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, informe os dados POST
- A resposta/ação esperada
- A resposta final recebida do servidor e a ação realizada (se houver)
Observe que, embora façamos nosso melhor para ajudar a solucionar os problemas com a API, isso pode ser desafiador. O motivo pelo qual isso acontece é porque não conseguimos ver o que está acontecendo com seu aplicativo, script ou ambiente.
Se você tem uma pergunta mais geral (sobre o funcionamento de um método específico de API 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 ficará documentado em modo público. 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.