Submenu desarrolladores

Utilizacion de SDK

En esta seccion se explicara como utilizar el SDK para registrarse a un sitios Tuidd y como utilizar los servicios de Tuidd.

 

Autorización

Existe varias posibilidades para loguaearse en un sitio que ha incorporado el boton de TUIDD, mediante un numero telefonico o mediante ALIAS

Acceso con Numero (MSISDN):

Digitar el numero comenzando con un '+' y el codigo de area. EJ: +54 11 XXXX XXXX

Se detectara de esta manera el pais automaticamente.

Presionar el boton 'INGRESAR'.

(IMAGEN DE BOTON DE TUIDD CON numero)

Acceso con Alias:

Ingresar el Alias registrado en la plataforma.

Presionar el boton 'INGREAR'

(IMAGEN DE BOTON DE TUIDD CON ALIAS)

 

Servicios

Tuidd SDK brinda facilidades al proveedor a la hora de consumir servicios de publicidad, encuestas, pagos, notificaciones y cupones. Para ello se provee de una API, interface de programacion, TuiddServicesClient. Para utilizar esta api se deben seguir los siguientes pasos:

  1. Inclusion de API Servicios
  2. Generacion de informacion del Servicio
  3. Llamado a funcion de Servicio

 

Inclusion de Servicios:

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

 

Generacion de informacion del Servicio

Es requerida informacion de Autorizacion, el token de servicio (obtenido por el proveedor) y el login_hint (ejemplo PCR) del usuario a quien se le desea enviar el servicio. Esta informacion sera empaquetada en un array() de php.

Luego, es necesaria la informacion del servicio, siendo el id del servicio (service_id) el unico obligatorio. Por ultimo, se podra anadir informacion adicional en un ExtraParams (Para mas informacion ver la seccion Class Reference y Ejemplos.)

 

Llamado a funcion de Servicio

Las posibles funciones a ejecutar son las siguientes:

  • SendAdvertisement
  • SendSurvey
  • SendNotification
  • SendCoupon
  • SendPayment

Los argumentos recibidos por estas funciones tienen que ver con informacion de autenticacion, informacion del servicio que se quiere consumir y que se registro en la plataforma Tuidd e informacion adicional del servicio, como por ejemplo la visualizacion del servicio.

 

Ejemplos

 

Enviar Encuesta

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 Publicidad

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