Submenu desarrolladores

Uso do SDK

Esta seção explicará como usar o SDK para se registrar nos sites da Tuidd e como usar os serviços da Tuidd.

 

Autorização

Existem várias possibilidades para entrar em um site que incorporou o botão TUIDD, através de um número de telefone ou através de ALIAS

Acesso com número (MSISDN):

Digite o número que começa com um '+' e o código de área. EJ: +54 11 XXXX XXXX

O país será detectado dessa maneira automaticamente.

Pressione o botão "ENTER".

(IMAGEM DO BOTÃO DE TUIDD COM O NÚMERO)

Acesso com Alias:

Digite o Alias ​​registrado na plataforma.

Pressione o botão 'INGREAR'

(IMAGEM DO BOTÃO TUIDD COM ALIAS)

 

Serviços

O Tuidd SDK fornece facilidades para o provedor quando se trata de consumir serviços de publicidade, pesquisas, pagamentos, notificações e cupons. Para isso, uma API, interface de programação, TuiddServicesClient é fornecida. Para usar esta API, você deve seguir os seguintes passos:

  1. Inclusão de serviços de API
  2. Geração de informações de serviço
  3. Chamada para a função de serviço

 

Inclusão de Serviços:

require_once("tuidd/libs/tuidd_lib/client/TuiddServicesClient.php");

 

Geração de informações de serviço

São necessárias informações de autorização, o token de serviço (obtido pelo provedor) e o login_hint (exemplo de PCR) do usuário para quem o serviço deve ser enviado. Esta informação será empacotada em um array () de php.

Então, as informações de serviço são necessárias, sendo o id do serviço (service_id) o único necessário. Finalmente, você pode adicionar informações adicionais em um ExtraParams (para obter mais informações, consulte a seção Referência de Classe e Exemplos).

 

Chamada para a função de serviço

As possíveis funções a serem executadas são as seguintes:

  • SendAdvertisement
  • SendSurvey
  • SendNotification
  • SendCoupon
  • SendPayment

Os argumentos recebidos por essas funções têm a ver com a informação de autenticação, serviço de informações que deseja consumir e que o registro na plataforma Tuidd e informações de serviço adicionais, como exibição do serviço.

 

Exemplos

 

Enviar pesquisa

require_once("tuidd/libs/tuidd_lib/client/TuiddClient.php");
require_once("tuidd/libs/tuidd_lib/client/TuiddServicesClient.php");

TuiddClient::getSingleton()->isLoggedIn();

// get user information
$userInfo = TuiddClient::getSingleton()->getUserInfo();
$sc = TuiddServicesClient::getSingleton();

// var_dump($userInfo);
// print user information...
echo Hello;
if ($userInfo['nickname'])
echo $userInfo['nickname'];
else if ($userInfo['name'])
echo $userInfo['name'];
else
echo $userInfo['given_name']." ".$userInfo['family_name'];

echo Your ID is:
echo $userInfo['sub'];

echo Your email is:
echo $userInfo['email'];

if (isset($_GET['encuesta'] ))
{
$service_id = $_GET['encuesta'];

$token = TuiddClient::getSingleton()->getSurveyServiceToken();
$authInfo = array(
'service_token' => $token->token,
'login_hint' => 'PCR:'. $userInfo['sub'],
);
$extraParams['display'] = 'push';
$serviceResult = $sc->sendSurvey( $service_id, $authInfo, $extraParams );

var_dump($serviceResult);
}

Enviar publicidade

require_once("tuidd/libs/tuidd_lib/client/TuiddClient.php");
require_once("tuidd/libs/tuidd_lib/client/TuiddServicesClient.php");


$sess_ = TuiddClient::blockStart('sdk-session');
TuiddClient::getSingleton()->isLoggedIn($sess_);

// get user information
$sc = TuiddServicesClient::getSingleton();
var_dump( $_GET['publicidad'] );

if (isset($_GET['publicidad'] ))

$service_id = $_GET['publicidad'];

$userInfo = TuiddClient::getSingleton()->getUserInfo();
$token = TuiddClient::getSingleton()->getSurveyServiceToken();
$authInfo = array(
'service_token' => $token->token,
'login_hint' => 'PCR:'. $userInfo['sub'],
);
$extraParams['display'] = 'push';
$redirect_link = 'url_link';

if ($service_id == 'any')

$serviceResult = $sc->sendAdvertisement( NULL, $authInfo, $extraParams );

else

$source = 'service_id';
$serviceResult = $sc->sendAdvertisement( $service_id, $authInfo, null, null, null, null, $redirect_link, $source, $extraParams );
TuiddClient::blockEnd($sess_);
var_dump( $serviceResult );

 

Class Reference

 
TuiddServicesClient Class Reference

Public Member Functions

  sendAdvertisement ($service_id, $authInfo, $title=NULL, $message=NULL, $link=NULL, $image_link=NULL, $redirect_link=NULL, $extraParams=NULL)
 
  sendPayment ( $price, $detail, $concept, $currency, $authInfo, $extraParams=NULL)
 
  sendNotification ( $service_id, $authInfo, $title=NULL, $message=NULL, $link=NULL, $extraParams=NULL)
 
  sendSurvey ( $service_id, $authInfo, $extraParams=NULL)
 
  sendCoupon ( $service_id, $authInfo, $title=NULL, $message=NULL, $coupon_type=NULL, $link=NULL, $image_link=NULL, $extraParams=NULL)
 

Static Public Member Functions

static  getSingleton ()
 

Member Function Documentation


◆  getSingleton()

static TuiddServicesClient::getSingleton (   )  
static

Gets Singleton's instance of TuiddClient

Parameters
none  
Returns
[type] [description]


◆  sendAdvertisement()

TuiddServicesClient::sendAdvertisement (   $service_id ,
      $authInfo ,
      $title = NULL ,
      $message = NULL ,
      $link = NULL ,
      $image_link = NULL ,
      $redirect_link = NULL ,
      $extraParams = NULL  
  )    

Envía una publicidad con la información recibida en los parámetros.

Parameters
string service_id [ID de servicio]
array authInfo [description]
string title [titulo de la publicidad]
string message [mensaje de la publicidad]
string link [link de la publicidad]
string image_link [link de la imagen publicidad]
string redirect_link [link de la redirect luego de recibir publicidad]
array extrParams [description]
Returns
array int $status Estado de envío de publicidad 200: OK 400: BAD REQUEST 401: UNAUTHORIZED 500: INTERNAL SERVER ERROR int $transaction_id ID de transacción de servicio


◆  sendCoupon()

TuiddServicesClient::sendCoupon (   $service_id ,
      $authInfo ,
      $title = NULL ,
      $message = NULL ,
      $coupon_type = NULL ,
      $link = NULL ,
      $image_link = NULL ,
      $extraParams = NULL  
  )    

Consume un servicio de cupon mediante la informacion enviada por parametro

Parameters
string service_id [ID de servicio]
array authInfo [description]
string title [titulo del cupon]
string message [mensaje del cupon]
string coupon_type [tipo de cupon ]
string link [link del cupon]
string image_link [link de la imagen de cupon]
array extraParams [description]
Returns
array int $status Estado de envío de publicidad 200: OK 400: BAD REQUEST 401: UNAUTHORIZED 500: INTERNAL SERVER ERROR int $transaction_id ID de transacción de servicio

◆  sendNotification()

TuiddServicesClient::sendNotification (   $service_id ,
      $authInfo ,
      $title = NULL ,
      $message = NULL ,
      $link = NULL ,
      $extraParams = NULL  
  )    

Consume un servicio de notificacion.

Parameters
string service_id [ID de servicio]
array authInfo [description]
string title [titulo de la notificacion]
string message [mensaje de la notificacion]
string link [link de la notificacion]
array extraParams [description]
Returns
array int $status Estado de envío de notificacion 200: OK 400: BAD REQUEST 401: UNAUTHORIZED 500: INTERNAL SERVER ERROR int $transaction_id ID de transacción de servicio


◆  sendPayment()

TuiddServicesClient::sendPayment (   $price ,
      $detail ,
      $concept ,
      $currency ,
      $authInfo ,
      $extraParams = NULL  
  )    

Consume un servicio de pago .

Parameters
float price [titulo de la pago]
string detail [description]
string concept [description]
string currency [description]
array authInfo [description]
array extraParams [description]
Returns
array int $status Estado de envío de pago 200: OK 400: BAD REQUEST 401: UNAUTHORIZED 500: INTERNAL SERVER ERROR int $transaction_id ID de transacción de servicio


◆  sendSurvey()

TuiddServicesClient::sendSurvey (   $service_id ,
      $authInfo ,
      $extraParams = NULL  
  )    

Consume un servicio de encuesta mediante el id del servicio.

Parameters
string serviceID [titulo de la encuesta]
array authInfo [description]
array extraParams [description]
Returns
array int $status Estado de envío de encuesta 200: OK 400: BAD REQUEST 401: UNAUTHORIZED 500: INTERNAL SERVER ERROR int $transaction_id ID de transacción de servicio

The documentation for this class was generated from the following file:
  • TuiddServicesClient.php

 

Entity Pager Example