Ativando a API e autenticação no Mautic

Ativando a API e autenticação no Mautic

Certifique-se que seu Mautic esteja com a API habilitada e funcionando corretamente

Este módulo utilização a API do Mautic para realizar suas operações, é necessário que sua instalação do Mautic esteja com a API e autenticação HTTP habilitados.

Para ativar a API, acesse o Mautic e selecione a opção configurações clicando sobre a roda no canto superior direito.

Para ativar a API, acesse o Mautic e selecione a opção configurações clicando sobre a roda no canto superior direito.

No menu lateral acesse “Configurações da API”, marque sim para as opções “A API está habilitada?” e “Ativar autenticação HTTP básica?”
No menu lateral acesse “Configurações da API”, marque sim para as opções “A API está habilitada?” e “Ativar autenticação HTTP básica?”

Adicionando usuário na função

Por questões de segurança, sugerimos que você crie uma regra de acesso para o usuário a ser configurado no WHMCS. Este usuário necessita de acesso completo nas permissões para poder manipular de forma corretas as informações através da API. Para criar uma nova função, acesse a roda no canto superior direito e acesse a opção “Função”. Clique no botão “Novo”, no campo “Nome” defina como whmcs.

Marque sim na opção Tem acesso total ao sistema? para que este conjunto de funções recebera acesso completo ao Mautic.

Criando o usuário


Por questões de controle e segurança, crie um usuário que será usado somente pelo WHMCS. Clique sobre a roda no canto superior direito e acesse a opção “Usuários”. Clique em “Novo” e adicione um usuário com informações que ajudem a identificar nos logs caso necessário.

Sugerimos os seguintes:

  • Primeiro nome: WHMCS
  • Sobrenome: API
  • Função: whmcs (caso não tenha criado as permissões e funções, reveja a etapa anterior)
  • Usuário: whmcs

Guarde este usuário e senha con segurança.

sempre utilize uma senha complexa

Testando a API

Para certificar-se que as etapas de configuração e ativação da API do Mautic foram bem sucedidas, realize um teste de conexão a API através do comando Curl a seguir:

curl -u user:password http://yourdomain.com/mautic/api/contacts

Esta chamada a API irá retornar a lista dos contatos cadastrados do seu Mautic em formato json, por exemplo:

{
    "total": "1",
    "contacts": {
        "5": {
            "isPublished": true,
            "dateAdded": "2018-12-22T14:18:11+00:00",
            "dateModified": "2018-12-22T14:25:18+00:00",
            "createdBy": null,
            "createdByUser": null,
            "modifiedBy": 1,
            "modifiedByUser": "Andre Bellafronte",
            "id": 5,
            "points": 0,
            "color": null,
    ...

            "tags": [],
            "utmtags": [],
            "stage": null,
            "dateIdentified": "2018-12-22T14:19:17+00:00",
            "preferredProfileImage": null,
            "doNotContact": [],
            "frequencyRules": []
        }
    }
}

Caso a API retorne algum erro, verifique a docmentação Error Handling da documentação do Mautic

Found errors? Think you can improve this documentation? edit this page