Introdução à API

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 sua URL e chave de API ActiveCampaign

Para permitir uma integração entre sua conta ActiveCampaign e um aplicativo de terceiros, você precisará primeiro obter sua URL e Key de API. A URL e a Key da API podem ser pensadas 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 executar outras tarefas.

Cada usuário em sua conta ActiveCampaign tem sua própria URL de API e Key.

Para obter sua URL e key do ActiveCampaign API, siga estas etapas:

1. Clique na opção "Configurações" localizada no menu de navegação do lado 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á sua URL e key da API ActiveCampaign. Você pode copiar e colar essas informações em sua aplicação de terceiros.

Como redefinir suas informações de API

Caso suas informações de API foram comprometidas, você pode redefinir sua chave.

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

Uma janela de confirmação aparecerá. Clique em "Ressentir a tecla 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:

  1. Conta AtivaCampaign válida (uma versão de teste também funcionará).
  2. Experimente a criação de soluções codificadas sob medida e/ou integração com APIs REST.
  3. Capacidade de enviar solicitações HTTP do seu servidor.

Fornecemos uma lista de métodos de API disponíveis, juntamente com descrições detalhadas de cada parâmetro, bem como exemplos em código real. Nosso fórum comunitário é um grande recurso, pois você está aprendendo 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 faltando ou qualquer coisa que o proíba de usar totalmente a API, entre em contato com nossa equipe de suporte e forneça as seguintes informações:

  1. URL de solicitação de 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 realizada (se houver)

Por favor, note que, embora façamos o nosso melhor para ajudá-lo a solucionar problemas de API, isso pode fornecer certos desafios. Isso porque não é possível para nós ver o que está acontecendo com seu aplicativo, script ou ambiente. 

Se você tem uma pergunta mais geral (como como um método específico de API 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 para que outros usuários possam ajudar, compartilhar suas próprias experiências e ajudar futuros usuários a aprender com experiências passadas.

Se você precisar de assistência para configurar algo usando a API, recomendamos trabalhar com um de nossos consultores certificados ou postar em nosso fórum comunitário.

Esse artigo foi útil?
Usuários que acharam isso útil: 6 de 8

Have more questions? Submit a request

Start free trial