❗️

ESSA SDK FOI DESCONTINUADO !!!

Utilizar as outras SDKs ou a parte da API

Api:

  • [API] (doc:rest-api) API

SDKs:

Esse SDK tem como objetivo automatizar a integração com a Rest API da Dito.

Endereço no Github: https://github.com/ditointernet/dito-php.

Instalação

Para instalar o SDK, você precisará usar o Composer.

Adicione o SDK para PHP da Dito como dependência do seu projeto no arquivo composer.json:

{
  "name": "dito/dito-example",
  "authors": [
    {
      "name": "Marcos Nogueira",
      "email": "[email protected]"
    }
  ],
  "require": {
    "dito/dito-php": "0.0.6"
  }
}

Execute:

$ composer install

Configurando sua aplicação

Adicione o código abaixo em cada ambiente de configuração da sua aplicação.
A variável $dito deverá ficar acessível em toda sua aplicação para que você possa executar os métodos do SDK a qualquer momento.

$dito = new Dito(array(
  'apiKey' => '{{SUA_API_KEY}}',
  'secret' => '{{SEU_SECRET}}'
));

As chaves da sua aplicação podem ser encontradas na área de configuração do seu aplicativo na plataforma da Dito.

Enviando seus usuários

O método $dito->identify é usado para enviar os usuários da sua aplicação para a plataforma da Dito.

O nó data é reservado para as informações do usuários relativas a sua aplicação. Fique a vontade para enviar quantas informações quiser.

As informações enviadas no nó data poderão ser utilizadas posteriormente para filtrar seus usuários. Veja mais informações sobre os formatos suportados para saber como enviar datas corretamente.

Exemplo:

$dito->identify(array(
  'id' => sha1('[email protected]'),
  'name' => 'Marcos Nogueira',
  'email' => '[email protected]',
  'birthday' => '1990-02-15',
  'created_at' => '2000-06-01T13:30-0300', //Opcional
  'data' => array(
    'cpf' => '101.032.076-95',
    'cargo' => 'Desenvolvedor'
  )
));

Criando eventos

O método $dito->track é usado para trackear o comportamento dos usuários na forma de eventos em sua aplicação.

O nó data é reservado para as informações do evento. Fique a vontade para enviar quantas informações quiser.

As informações enviadas no nó data poderão ser utilizadas posteriormente para filtrar seus usuários. Veja mais informações sobre os formatos suportados para saber como enviar datas corretamente.

ATENÇÃO

Os nomes dos eventos DEVEM ser enviados para a Dito em letras minúsculas, sem acentuação ou caracteres especiais. Caso o nome de suas ações seja composto por mais de uma palavra, estas devem ser separadas por hífen '-' conforme o exemplo abaixo:

Exemplo:

$dito->track(array(
  'id' => sha1('[email protected]'),
  'event' => array(
    'action' => 'nome-do-evento',
    'revenue' => 5.99, // Opcional
    'created_at' => '2005-06-01T13:30-0300' //Opcional
    'data' => array(
      'propriedade_1' => 'valor da propriedade 1',
      'propriedade_2' => 'valor da propriedade 2'
    )
  )
));

Associando outras contas ao usuário

O método $dito.link é usado para associar contas à um usuário já identificado. Só é possível associar contas que ainda não estão criadas na Dito.

Exemplo de associação para um usuário:

$dito->link(array(
 'id' => ID_PRINCIPAL_DO_USUARIO,
 'accounts' => array(
   'portal' => array(
     'id' => ID_A_SER_ASSOCIADO
   )
 )
));

Desassociar contas do usuário

O método $dito.unlink é usado para remover a associação de uma conta de usuário. Ele é o inverso do método $dito.link.

Exemplo:

$dito->unlink(array(
 'id' => ID_PRINCIPAL_DO_USUARIO,
 'accounts' => array(
   'portal' => array(
     'id' => ID_A_SER_DESASSOCIADO
   )
 )
));