Utilize o RD Station Ruby Client, projeto Open Source que acelera o desenvolvimento de suas integrações

Na Resultados Digitais (RD), utilizamos Ruby on Rails como principal framework de desenvolvimento. Pensando cada vez mais em nos aproximarmos da comunidade de desenvolvedores, mantemos algumas bibliotecas open source, como exemplo o projeto rdstation-ruby-client, criado para facilitar a interação no consumo de nossa API de integração com o produto RD Station Marketing (RDSM).

Atualmente, a API de integração do RDSM possui uma centena de integrações com aplicações de diversos segmentos da indústria como E-Commerce, CRM, Chat, entre outros. Você pode encontrar na RD Station App Store todos os aplicativos conectados ao nosso produto.

Motivação

Desde o RD Summit 2017, principal evento da Resultados Digitais, disponibilizamos uma nova versão da API de integração com o RDSM, trazendo muitas melhorias em relação à versão anterior, como exemplo a utilização do protocolo OAuth para autenticação.

Com o objetivo de fornecer à comunidade de desenvolvimento, uma maneira simples e prática de aproveitar todas as novidades e melhorias da nova versão, aproveitamos o mês de open source na RD e atualizamos o projeto rdstation-ruby-client.

Outras melhorias da API 2.0:

• Criação, atualização e consulta das informações de contatos;
• Manipulação dos campos personalizados da conta;
• Todas as ações relacionadas a webhooks que antes eram possíveis apenas pela tela interna do RDSM, agora são possíveis via API;
• Realizar a marcação de uma venda ou atualizar o estágio do funil do Lead;
• Envio de eventos customizados para o contato: hoje as versões mais antigas da API permitem apenas a criação de novas conversões para os leads.

A documentação completa e todas as informações sobre endpoints, entidades e respostas da API podem ser encontradas em nosso Portal de Desenvolvedores, nele estão disponíveis todas as informações necessárias para auxiliar no processo de construção de novas integrações.

Expectativas

Através desse projeto open source esperamos facilitar o caminho para a comunidade Ruby que gostaria de desenvolver soluções conectadas ao RD Station Marketing e também compartilhar o código-fonte para desenvolvedores que desejam contribuir com melhorias tornando assim a biblioteca ainda mais poderosa!! 💪

Como utilizar o rdstation-ruby-client ?

1. Adicione a linha abaixo no Gemfile do seu projeto:

gem ‘rdstation-ruby-client’

2. Instale a gem através do bundler:

bundle install

Você também pode instalar a gem diretamente no seu ambiente, desta forma:

gem install rdstation-ruby-client

Exemplos de utilização

a) Como obter as informações de contato através de um e-mail?

client = RDStation::Client.new(access_token: MY_ACCESS_TOKEN)
client.contacts.by_email('email@example.org')

b) Como registrar um evento de venda ?

event_payload = {
  "event_type" => "SALE",
  "event_family" =>"CDP",
  "payload" => {
    "email" => "email@email.com",
    "funnel_name" => "default",
    "value" => 200
  }
}
client = RDStation::Client.new(access_token: MY_ACCESS_TOKEN)
client.events.create(event_payload)

Mês do Open Source na RD

Durante todo o mês de Abril tivemos uma iniciativa em nosso time de produto e engenharia focada em melhorias de nossas iniciativas open source, foi o momento então que escolhemos revisitar a nossa biblioteca de Ruby para trazermos as últimas atualizações de nossa API, esperamos que essa atualização ajude a comunidade.

Conheça também os nossos outros projetos Open Source em http://opensource.resultadosdigitais.com.br. Sua contribuição será muito bem vinda!

😍 Este post não seria o mesmo sem a ajuda de vocês ⏬

Ana Carolina Rodrigues, João Eduardo Hornburg, Lucas Macedo, Sérgio Alves de Toledo, Tiago Muraro, arthur valentim kasper e Rafael Hancke. ❤