matheushack/rd-station

Integration RD Station Marketing

1.0 2024-02-03 04:17 UTC

Requires

• php: ^8.0
• guzzlehttp/guzzle: ^7.8

MIT

• Matheus Hack

README

Projeto em Laravel para integração módulo de marketing do RD Station.

Instalação

Composer

composer required matheushack/rd-station

ou

"matheushack/rd-station": "^1.0"

Contato

No RD Station todos os registros de pessoas são referidos como Contatos, independentemente de serem classificados como Leads, Leads Qualificados ou Clientes a partir de uma perspectiva de vendas.

Ao criar um Contato ele pode ser qualificado com um conjunto de campos padrão, como email, nome, cargo, empresa, cidade, estado, etc.. O campo padrão chave de identificação dos contatos dentro do RD Station é o "email" deste Contato, que sempre será único.

Campo	Tipo	Obrigatório	Exemplo
name	string	Não	Matheus Silva
email	string	Sim	[e-mail]
jobTitle	string	Não	Developer
birthDate	string	Não	1992-12-12
bio	string	Não	Bio do usuário
website	string	Não	exemplo.com.br
personalPhone	string	Não	[phone]
mobilePhone	string	Não	[phone]
city	string	Não	São Paulo
state	string	Não	SP
country	string	Não	Brasil
twitter	string	Não	twitter.com
facebook	string	Não	facebook.com
tags	array	Não	['tag1', 'tag2']

Conversão

O RD Station Marketing considera o valor do atributo conversion_identifier como identificador do evento customizado. Esse evento é registrado sempre que ocorre uma conversão.

• Principal

Campo	Tipo	Obrigatório	Exemplo
eventType	string	Sim	CONVERSION
eventFamily	string	Sim	CDP
payload	array	Sim	PayloadObject

• PayloadObject

Campo	Tipo	Obrigatório	Exemplo
conversionIdentifier	string	Sim	Conversão exemplo
email	string	Sim	[e-mail]

Exemplos

1. Contato

• Criar

<?php
require_once '../vendor/autoload.php';

use MatheusHack\RdStation\Contact;
use MatheusHack\RdStation\Requests\ContactRequest;

$request = (new ContactRequest())
    ->setEmail('[e-mail]');

$response = (new Contact())
    ->create($request);

• Editar

<?php
require_once '../vendor/autoload.php';

use MatheusHack\RdStation\Contact;
use MatheusHack\RdStation\Requests\ContactRequest;

$request = (new ContactRequest())
    ->setEmail('[e-mail]')
    ->setName('Example')
    ->setJobTitle('Developer')
    ->setBirthDate('1992-12-14')
    ->setBio('Bio example')
    ->setWebsite('example.com.br')
    ->setCity('São Paulo')
    ->setState('SP')
    ->setCountry('Brasil')
    ->setTags([
        'teste',
    ]);

$response = (new Contact())
    ->update($request);

• Procurar

<?php
require_once '../vendor/autoload.php';

use MatheusHack\RdStation\Contact;
use MatheusHack\RdStation\Requests\ContactRequest;

$request = (new ContactRequest())
    ->setEmail('[e-mail]');

$response = (new Contact())->find($request);

2. Conversão

• Criar

<?php
require_once '../vendor/autoload.php';

use MatheusHack\RdStation\Conversion;
use MatheusHack\RdStation\Requests\ConversionRequest;
use MatheusHack\RdStation\Requests\ConversionPayloadRequest;

$payload = (new ConversionPayloadRequest())
    ->setConversionIdentifler('Conversão exemplo')
    ->setEmail('[e-mail]');

$request = (new ConversionRequest())
    ->setEventType('CONVERSION')
    ->setEventFamily('CDP')
    ->setPayload($payload);

$response = (new Conversion())
    ->create($request);