Ajuda

Uma vez que você tenha dados armazenados na MailerWeb, você poderá consultar sempre que precisar, de forma integrada à sua base de dados, as campanhas realizadas pela MailerWeb, abaixo iremos mostrar como você pode resgatar de sua conta, inclusive realizar o cruzamentos de contatos com engajamento em campanhas.

Para se integrar à API é necessário que você esteja autenticado e para isso é importante que você tenha acesso ao artigo "Como se integrar a API da MailerWeb?"

Importante que o requisito para utilizar essa API é o contato estar criado dentro da base de contatos da MailerWeb, através da inclusão manual, da importação de contatos ou através da inclusão via API, conforme a seção "Como criar um contato utilizando a API da MailerWeb?"

Passo 1: Realizando uma consulta através de e-mail

Esse modalidade permite que você faça uma consulta à base de dados mostrando os dados de um contato a partir de uma chamada por e-mail, vejamos:

GET: /api/v1/contacts/contact/

curl --dump-header - -H "Accept: application/json"\
 -H "Authorization: ApiKey username:API_KEY"\
 https://painel.mailerweb.com.br/api/v1/contacts/contact/?email=fulano%40domain.com

ATENÇÃO: Você deverá utilizar algum algoritmo para realizar um URL encode quando passar como parâmetro o e-mail, sempre substituindo o @ por %40.

O resultado esperado estará descrito abaixo:

{
    "meta": {
        "limit": 100,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [{
        "campaigns": [{'id':ID_CAMPAIGN,'was_read':True,'click': True}],
        "clicked": false,
        "date_created": "2020-01-10T20:21:18.773000",
        "email": "fulano@domain.com",
        "email_format": "html",
        "id": "5e18dcbfffdb0f1f1dXXXX",
        "ip_address_confirmation": null,
        "ip_address_inclusion": null,
        "is_confirmed": false,
        "last_updated": "2020-01-10T20:21:19.048000",
        "lead_score": "3.00",
        "name": "bla",
        "opt_out": false,
        "opt_out_reason": null,
        "resource_uri": "/api/v1/contacts/contact/5e18dcbfffdb0f1f1d57f044/",
        "status": "ok",
        "tag_list": ["XXX_ID_LISTA"],
        "was_checked": false
    }]
}

Passo 2: Como buscar um contato a partir de uma participação em uma campanha?

GET: /api/v1/contacts/contact/

curl --dump-header - -H "Accept: application/json"\
 -H "Authorization: ApiKey username:API_KEY" \
 https://painel.mailerweb.com.br/api/v1/contacts/contact/?campaigns_match=ID_CAMPAIGN

O resultado esperado dessa consulta:

{
    "meta": {
        "limit": 100,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [{
        "campaigns": [{'id':ID_CAMPAIGN,'was_read':True,'click': True}],
        "clicked": false,
        "date_created": "2020-01-10T20:21:18.773000",
        "email": "fulano@domain.com",
        "email_format": "html",
        "id": "5e18dcbfffdb0f1f1dXXXX",
        "ip_address_confirmation": null,
        "ip_address_inclusion": null,
        "is_confirmed": false,
        "last_updated": "2020-01-10T20:21:19.048000",
        "lead_score": "3.00",
        "name": "bla",
        "opt_out": false,
        "opt_out_reason": null,
        "resource_uri": "/api/v1/contacts/contact/5e18dcbfffdb0f1f1d57f044/",
        "status": "ok",
        "tag_list": ["XXX_ID_LISTA"],
        "was_checked": false
    }]
}