Use a API do importador de contato a granel

Com o ActiveCampaign, você pode usar a API do Importador de Contato em Massa para carregar um grande número de contatos em sua conta com apenas uma chamada de API.

Tome nota

  • A API do Importador de Contato em Massa está disponível em todos os planos ActiveCampaign
  • Este recurso é para usuários avançados que estão familiarizados com a API e são confortáveis em usá-lo para importar contatos

Sobre a API importador de contato a granel

O importador de contato a granel foi projetado para realizar operações em grandes quantidades de contatos ao mesmo tempo. Essas operações incluem:

  • Criando novos contatos
  • Atualização de contatos existentes
  • Definindo campos em contatos
  • Contatos de marcação
  • Adição de contatos a listas

Observação:

O Importador de Contato em Massa não foi projetado para suportar operações frequentes envolvendo um pequeno número de contatos ou para sincronizar atualizações em tempo real a partir de um banco de dados externo. Em vez disso, as atualizações de contato devem ser coletadas em lotes maiores e importadas em grupo. Os contatos podem ser importados em lotes de até 250 itens.

Se você precisar carregar 10 ou menos contatos por vez, use a funcionalidade Contatos do nosso ActiveCampaign API V3.  

Limitação de taxas

O processo de importador a granel é otimizado para o upload de listas maiores de contatos. Executar solicitações frequentes que envolvem um pequeno número de contatos requer sobrecarga significativa, e pode afetar o ’ desempenho do importador. Como resultado, aplicamos os seguintes limites de taxa na API do Importador de Contato em Massa:

  • Para solicitações que contenham um único contato, há um limite de 20 solicitações por minuto
  • Para solicitações contendo vários contatos, há um limite de 100 solicitações por minuto

Recomendamos que todos os usuários tentem fazer atualizações em grupos o maior possível antes de iniciar uma importação.

Limitação do tamanho da carga

O tamanho máximo da carga útil de uma única solicitação de bulk_import é de 400000 bytes.

Contatos ignorados

Os contatos devem atender a todos os seguintes critérios para serem criados ou atualizados com esta API:

  • Os contatos importados não podem exceder o limite da sua conta
  • O contato deve ter um endereço de e-mail
  • O ’ endereço de e-mail do contato não deve estar em uma lista de exclusão
  • O ’ e-mail do contato não deve estar em uma lista de endereços de e-mail recuperados
  • O contato não deve ter desubscrevido a uma lista que a importação os adicionaria a

Se os contatos não atenderem a todos esses requisitos, eles serão ignorados pelo importador.

Documentação da API

HTTPS://YOURACCOUNTNAME.API-US1.COM/API/3/IMPORT/BULK_IMPORT   PÓS

Estrutura de solicitação

JSON
•
Contatos:
    •
        "e-mail": "someone@somewhere.com",
        Nome Jane
        Sobrenome "Doe",
        Telefone 5
		"customer_acct_name": ActiveCampaign
        Tags
            		"dictumst aliquam augue quam sollicitudin rutrum",
        		•
        "campos": [
{"id": 1, "valor": "foo"},
{"id": 2,"valor": "foo|| bar|| baz"}
        •
        "inscreva-se": [{"listid": 1}, {"listid": 2
        "cancelar a inscrição": [{"listid": 3
    •
•
"callback": <opcional, veja abaixo>
•

Resposta
200 OK
•
Sucesso:
"queued_contacts":1,
"batchId":"0641fbdd-f62f-4c2c-ba02-3a83d5d5d11ac9",
"mensagem":"Importação de contato enfileiada"
•
 
400 Pedido ruim
•
Sucesso:
"mensagem":"A carga JSON não passou da validação. Por favor, corrigir falhasReasons e tentar novamente. A importação não estava na fila para processamento.",
"failureReasons":["A carga deve conter um campo de 'contatos'"]
}

 

Params corporais

contatos* matriz (objeto)

Uma série de objetos contendo informações sobre um único contato. Até 250 contatos podem ser incluídos em uma única solicitação. Cada contato pode conter os seguintes campos:

  • e-mail* (string)
    O ’ e-mail do contato.
  • first_name (string)
    O ’ primeiro nome do contato.
  • last_name (string)
    O ’ sobrenome do contato.
  • telefone (string)
    O ’ telefone do contato.
  • customer_acct_name (string)
    O nome ’ da conta de contato.
  • matriz de tags (string)
    Cada string na matriz será adicionada como uma única tag ao contato. Novas tags serão criadas se elas ainda não existirem.
  • matriz de campos (objeto)
    Uma lista de campos personalizados para aplicar ao contato. Cada campo deve conter dois campos: Cada contato pode ter até n campos personalizados.
  • id*   (número)
    A ID do campo personalizado. Os campos personalizados devem ser referenciados pelo ID que o ActiveCampaign atribui a eles. Você pode recuperar o número de identificação de um campo personalizado usando a chamada API "List todos os campos personalizados".
  • valor*   (string)
    O valor do campo personalizado. Vários valores podem ser preenchidos para campos de vários valores, separando os diferentes valores pelo delimitador de canos duplos ( “ || ” ).
  • subscrever array (objeto)
    Uma série de listas para assinar o contato. Os contatos não podem ser subscritos em listas das quais eles não foram subscritos anteriormente. Cada objeto de lista contém um único campo.
  • listid* (número)
    A ID da lista para assinar o contato. As listas devem ser referenciadas pelo ID que o ActiveCampaign atribui a elas.

    Você pode encontrar o ID da lista clicando na lista em sua conta ActiveCampaign e visualizando a barra de URL. Vai ficar mais ou menos assim: /app/contatos/? listid=19&status=1

    Você também pode recuperar o número de identificação de uma lista usando a chamada API "Recuperar todas as listas".
  • matriz   de cancelamento de inscrição (objeto)
    Uma série de listas para cancelar a inscrição do contato. Cada objeto de lista contém um único campo.
  • listid*   (número)
    A ID da lista para cancelar a inscrição do contato. As listas devem ser referenciadas pelo ID que o ActiveCampaign atribui a elas.

    Você pode encontrar o ID da lista clicando na lista em seu ActiveCampaign e, em seguida, visualizando a barra de URL. Vai ficar mais ou menos assim: /app/contatos/? listid=19&status=1

    Você também pode recuperar o número de identificação de uma lista usando a chamada API "Recuperar todas as listas".

Retornos

O ponto final de contato em massa tem uma função de retorno de chamada para notificar os usuários quando uma importação estiver concluída. Inclua as seguintes informações em uma solicitação de importação de contato para usar este recurso:

JSON
{
“url ” : “” www.your_web_server.com,
"contatos": [ ... incluir contatos aqui... ],
“retorno de ” chamada : {
	“requestType ” : “”CORREIO,
	“detailed_results ” : “” verdade,
	“”params : [
		{ “ tecla : , valor : ””””””” }
    ]
	“cabeçalhos ” : [
		{ “ tecla : , valor : ””””””” }
    ]
}
}
  • url   (string)
    O ponto final da URL para o qual o importador fará uma solicitação assim que a importação for concluída.
  • requestType (string)
    Pode ser definido para “ GET ” ou POST “” . Determina o tipo de solicitação HTTP que será enviada para o ponto final especificado.
  • detailed_results (string)
    Quando definido como “ verdadeiro e o parâmetro de ” solicitaçãoType for definido como “” POST, o retorno de chamada incluirá o número de sucessos e falhas na solicitação de origem, bem como uma série de mensagens de erro para cada contato com falha.
  • params   (matriz)
    Uma lista de parâmetros a serem incluos na solicitação de retorno de chamada. Adicione cada parâmetro na forma de um par de valor-chave. Para uma solicitação GET, cada parâmetro será anexado ao final da URL em uma sequência de consulta. Para uma solicitação POST, os parâmetros serão incluídos no corpo da solicitação. 
  • cabeçalhos (matriz)
    Uma lista de cabeçalhos para incluir na solicitação de retorno de chamada. Adicione cada cabeçalho na forma de um par de valor-chave.

Exemplos

Receber uma notificação

{
"contatos": [ ... incluir contatos aqui... ],
“retorno de ” chamada : {
	“url ” : “” www.yourwebsite.com/the/api/to/hit,
    “requestType ” : “”GET,
	“”params : [
		{ “ chave ” : ” msg , valor : ”” olá ””” }
    ]
	“cabeçalhos ” : [
		{ “ tecla : , valor : ””””””” }
    ]
}
}

 

Os params serão anexados à URL como parâmetros de consulta no caso de uma “” solicitação GET. Os cabeçalhos serão aplicados à solicitação antes de serem enviados. Este ponto final aceita qualquer valor de sequência para chaves e valores para param e cabeçalhos.

Resultado:

Obter www.yourwebsite.com/the/api/to/hit?msg=hello

Postando uma mensagem

{
"contatos": [ ... incluir contatos aqui... ],
“retorno de ” chamada : {
	“requestType ” : “”CORREIO,
	“”params : [
		{ “ chave ” : ” msg , valor : ” Importação concluída ”””” }
    ]
	“cabeçalhos ” : [
		{ “ chave : Autorização , valor : Portador 4u1h_t0k3N ””””””” }
    ]
}
}

 

Resultado:

Obter www.yourwebsite.com/the/api/to/hit

JSON
[
{ “ chave ” : ” msg , valor : ” Importação concluída ”””” }
]

 

Resultados de importação com mensagens de erro

{
"contatos": [ ... incluir contatos aqui... ],
“retorno de ” chamada : {
	“requestType ” : “”CORREIO,
	“detailed_results ” : “” verdade,
	“cabeçalhos ” : [
		{ “ tecla : , valor : ””””””” }
    ]
}
}

 

Quando o “ parâmetro detailed_results for definido como ” "True", o retorno de chamada incluirá:

  • Um objeto JSON contendo os params especificados
  • Três outros campos na resposta que podem ajudar no monitoramento e depuração

Resultado:

Obter www.yourwebsite.com/the/api/to/hit

JSON
{
"Sucesso":1,
"Falhas":0,
"failure_reasons":[]
}
Esse artigo foi útil?
Usuários que acharam isso útil: 0 de 1

Have more questions? Submit a request

Start free trial