Esta gem automatiza a integração de seu projeto com a Rest API da Dito.

Veja o código no Github: (ditointernet/dito-gem)[https://github.com/ditointernet/dito-gem].

Instalação

Adicione a linha abaixo no arquivo Gemfile da sua aplicação:

gem 'dito'

E execute:

$ bundle

Ou instale manualmente:

$ gem install dito

Configurando sua aplicação

Adicione o código abaixo em cada ambiente de configuração da sua aplicação.

Dito.configure do |c|
  c.api_key = 'SUA_API_KEY'
  c.secret  = 'SUA_SECRET'
end

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, sendo possível fazer filtros por data. Veja mais informações sobre os formatos suportados para saber como enviar datas corretamente.

Exemplo:

Dito.identify({
  id: Digest::SHA1.hexdigest('[email protected]'),
  name: 'Marcos Nogueira',
  email: '[email protected]',
  gender: 'male',
  location: 'Belo Horizonte',
  birthday: '1990-02-15',
  data: {
    cpf: '101.032.076-95',
    cargo: 'Desenvolvedor'   
  }
})

Criando eventos

O método Dito.track é usado para acompanhar 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, sendo possível fazer filtros por data. 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({
  id: Digest::SHA1.hexdigest('[email protected]'),
  event: {
    action: 'nome-do-evento',
    revenue: 5.99, # Opcional
    data: {
      propriedade_1: 'valor da propriedade 1',
      propriedade_2: 'valor da propriedade 2'
    }
  }
})