firedevbr/kaizen-css-client

Client para comunicação com a ferramenta de controle de leads CSS da agência Kaizen

dev-master 2021-01-22 02:42 UTC

Requires

• php: >=7.2
• guzzlehttp/guzzle: ^7.2

MIT

• Firedev

README

Client para consumir a API de integração com a ferramenta de gerência de leads CSS da agência Kaizen.

Como utilizar

Para utilizar o client, basta instanciar a classe Firedev\KaizenCSS\Client e com isso temos acesso as suas funções:

$cssClient = new Firedev\KaizenCSS\Client();

Para registrar um novo lead

Basta chamar a função registraLead e passar os dados do lead como parâmetro:

$cssClient = new Firedev\KaizenCSS\Client();

$cssClient->registraLead(
    'Mateus Pereira',
    '[e-mail]',
    '51-999999999',
    'Tenho interesse no produto X disponível na home do site'
);

Com isso, será feita a comunicação com a API da agência Kaizen para registrar o lead.

Para registrar campos extras, basta passar o quinto argumento com uma lista de campos no seguinte formato:

[
    [
        'key'        => 'type',
        'title'      => 'Tipo',
        'value'      => 'venda',
        'searchable' => 1
    ]
];

Então digamos que queiramos passar o cpf também como um campo extra:

$cssClient = new Firedev\KaizenCSS\Client();

$additionalFields = [
    [
        'key'        => 'cpf',
        'title'      => 'cpf',
        'value'      => '861.338.151-80',
        'searchable' => 1
    ]
];

$cssClient->registraLead(
    'Mateus Pereira',
    '[e-mail]',
    '51-999999999',
    'Tenho interesse no produto X disponível na home do site',
    $additionalFields
);

Atenção

É necessário ter o script de monitoramento JS instalado no site para poder funcionar corretamente o client. Para saber como fazer a instalação do JS basta acessar o link oficial da documentação.

Pré Build

Para subir a imagem é importante antes de fazer o build da imagem setar o ID do seu usuário como usuário apache. Para isto basta executar o script set-user-id.sh que está na raiz.