Web Service

13/10/2015 by Jeenga

Filed under Documentação Integração

Last modified 15/02/2016

Identificação de Usuários

Endpoint: https://api.jeenga.com/jeenga-api/customer
(Os parâmetros devem ser passados como QueryString usando os métodos POST ou GET)

Parâmetros obrigatórios

j_apikey É a chave de identificação fornecida pela Jeenga (Encontrada no seu menu Integrações da plataforma Jeenga).
identifier ID único do Cliente (ele é responsável também por marcar seu contato como um cliente).

Parâmetros opcionais reconhecidos pela Jeenga

name Nome do Contato.
email E-mail do Contato.
customer_type Indica qual o tipo de contato (CLIENT, LEAD ou VISITOR).
phone_number Número de telefone do Contato (formato: +551198765432).
mobile Número de celular do Contato (formato: +5511987654321).
gender Gênero(sexo) do Contato (formato: M ou F).
avatar Imagem/Foto do Contato (formato: https://…).
birthday Data de nascimento do Contato (formato: 2015-07-25T09:30:15.000Z).
created_at Data de cadastro do Contato. Se não for informada, será utilizada a data de cadastro na Jeenga. (formato: 2015-07-21T09:30:15.000Z).
gcm_token Token para envio de Push Notification no android.
apns_token Token para envio de Push Notification no iOS.
onesignal_player_id ID fornecido pela API OneSignal. Utilizado para envio de push browser.
blocked_email Flag indicando se o envio de e-mails provenientes de campanhas foram bloqueados para este contato (true: não recebe e-mails, false: recebe e-mails).
blocked_sms Flag indicando se o envio de sms provenientes de campanhas foram bloqueados para este contato (true: não recebe sms, false: recebe sms).
blocked_mobile_push Flag indicando se o envio de push mobile provenientes de campanhas foram bloqueados para este contato (true: não recebe push mobile, false: recebe push mobile).
blocked_browser_push Flag indicando se o envio de push browser provenientes de campanhas foram bloqueados para este contato (true: não recebe push browser, false: recebe push browser).

Observações

A Jeenga aceita qualquer outro parâmetro do seu contato. Esse parâmetro é gravado e será identificado como atributo personalizado do seu Contato.

Exemplo chamado

curl https://api.jeenga.com/jeenga-api/customer?j_apikey=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&identifier=1234&name=Joaquim%20Silva&email=joaquim%40email.com

Tracking de atividades

API Endpoint: https://api.jeenga.com/jeenga-api/activity
(Os parâmetros devem ser passados como QueryString usando os métodos POST ou GET).

Parâmetros obrigatórios

j_apikey É a chave de identificação fornecida pela Jeenga (Encontrada no seu menu Integrações da plataforma Jeenga).
identifier ID único do Contato (Relaciona esta atividade a um Contato).
event Nome do evento que está sendo trackeado. (ex: clicou em comprar, cadastrou, deslogou, tentou comprar, não comprou, finalizou a compra).
module Módulo do evento (Ex: Login, logout, cadastro, landpage, produto, carrinho).
channel Canal do evento (ex: APP, Site, Ecommerce, Ibeacon, PDV Loja).

Parâmetros opcionais reconhecidos pela Jeenga

conversion_value Utilizado em eventos de conversão para contabilizar a quantidade de conversões que um determinado contato fez (ex: Número Inteiro: 1, 2, 10).
conversion_amount Utilizado em eventos de conversão para contabilizar o valor gasto por um determinado contato (ex: Valor monetário: 1.99, 9.90, 54.90, 100).

Observações

A Jeenga aceita qualquer outro parâmetro do seu contato. Esse parâmetro é gravado e será identificado como atributo personalizado do seu Contato.

Exemplo chamado

curl https://api.jeenga.com/jeenga-api/activity?j_apikey=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee&event=Play&module=Games&channel=Mobile&identifier=1234

Leave a Comment