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 permitir uma integração, entre sua conta ActiveCampaign e um aplicativo de terceiros, você precisará primeiro obter seu URL e sua chave da API. O URL e a chave da API podem ser considerados como seu nome de usuário e senha para sua conta ActiveCampaign. Quando você dá essas informações a um aplicativo de terceiros, eles poderão acessar sua conta para sincronizar informações ou realizar outras tarefas.
Cada usuário em sua conta ActiveCampaign tem sua própria URL e chave da API.
Para obter sua URL e chave do API da ActiveCampaign, siga estas etapas:
- Clique em "Configurações" (ícone de engrenagem) no menu esquerdo.
- O menu Configurações da conta será exibido. Clique na opção "Desenvolvedor".
- Copie o URL e chave da API e cole nos aplicativos de terceiros.
Como redefinir suas informações de API
Caso suas informações de API foram comprometidas, você pode redefinir sua chave.
Para redefinir as informações da API:
- 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ê precisará 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 dos métodos de API disponíveis, junto com descrições detalhadas de cada parâmetro, bem como exemplos de código. O fórum da nossa comunidade é um ótimo recurso à medida em 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 ajudar você com suas dúvidas sobre a API.
Solução de problemas da 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 suporte 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 final recebida do servidor e a ação realizada (se houver)
Observe que, embora façamos nosso melhor para ajudar você 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ê tiver uma pergunta mais geral (por exemplo, sobre como um método de API específico funciona ou por que uma API específica não está retornando dados), a recomendação é postar o problema em nosso fórum de usuários, pois lá ele é documentado publicamente para que outros usuários possam ajudar, compartilhar suas próprias experiências e ajudar futuros usuários a aprender com experiências anteriores.
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.