Obtniendo la lista de suscripciones (vigentes) para un Usuario.
soporte, ws.webtv, api, tienda, suscripciones
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | store | La sección del API |
do | list_subscriptions | La acción del API |
iq | ID Usuario | El ID del Usuario |
URL Resultante:
La URL de solicitud resultante sería similar a la siguiente (no se olvide de añadir la información requerida key, timestamp, salt and signature):
https://....../api.php?go=store&do=list_subscriptions&iq={id_usuario}&{información requerida}
Ninguna. No se requiren variables POST para esta solicitud.
Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• list: (array) Un arreglo con la lista de contenidos (el arreglo puede estar vacío). Cada uno incluirá:
- content_title: (string) EL título del contenido asociado a la suscripción.
- date_end: (int) Estampa de tiempo Unix con la fecha de expiración (renovación) para la suscripción.
- date_end_formatted_d: (string) El valor anterior, con formato (porción de fecha).
- date_end_formatted_t: (string) El valor anterior, con formato (porción de tiempo).
- id: (int) ID de la subcripció.
- id_product: (int) ID del producto relacionado con la suscripción.
- renewable: (int 0|1) Si la suscripción es renovable o no (si es renovable, la WebTV le pedirá al Usuario que pague en la fecha de renovación - o, en el caso de haber un perfile de pagos periódicos, utilizará el método de pago asociado para saber si el pago correspondiente se ha realizado).
- subscription_number: (string) el número de suscripción.
*** Datos relacionados con pagos periódicos ***
- rp_profile_id: (string) El ID del perfil de pagos (en caso de haberlo).
- rp_status: (string) El estado del perfil de pagos periódico (en caso de haberlo) (blank, Active, Pending, Cancelled, Suspended, Expired, ...).
- rp_amount: (decimal) El importe cobrado en cada renovación.
- rp_amount_formatted: (string) El valor anterior, con formato.
- rp_currency_code: (string) El código de moneda.
- rp_date_last_payment: (int) Estampa de tiempo Unix con la fecha del último pago realizado.
- rp_date_last_payment_formatted_d: (string) El valor anterior, con formato (porción de fecha).
- rp_date_last_payment_formatted_t: (string) El valor anterior, con formato (porción de tiempo).
- rp_date_start: (int) Estampa de tiempo Unix con la fecha del primer pago periódico.
- rp_date_start_formatted_d: (string) El valor anterior, con formato (porción de fecha).
- rp_date_start_formatted_t: (string) El valor anterior, con formato (porción de tiempo).
- rp_id_payment_method: (int) ID del método de pago utilizado para los pagos periódicos.
- rp_period_unit: (int) La unidad de tiempo para el pago (DAY, WEEK, MONTH or YEAR).
- rp_period_amount: (int) La frecuencia del período de pago.
Ejemplo:
{ "list": [{ "content_title": "Premium Channel", "date_end": "1509177992", "date_end_formatted_d": "28\/10\/2017", "date_end_formatted_t": "10:06:32 AM", "id": "26", "id_product": "6", "renewable": "1", "rp_amount": "10.00", "rp_amount_formatted": "10\u20ac", "rp_currency_code": "EUR", "rp_date_last_payment": "0", "rp_date_last_payment_formatted_d": "", "rp_date_last_payment_formatted_t": "", "rp_date_start": "1508916090", "rp_date_start_formatted_d": "25\/10\/2017", "rp_date_start_formatted_t": "09:21:30 AM", "rp_id_payment_method": "3", "rp_period_amount": "1", "rp_period_unit": "MONTH", "rp_profile_id": "MyUniqueExtAPIProfileID", "rp_status": "Active", "subscription_number": "SUBS00026" }] }
Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:
• REQUEST_ERROR | Invalid User ID:
El ID del Usuario no es numérico o es menor que 1.
Preparando los datos GET y POST.
// Las variables GET $GET_VARS = array( "go" => "store", "do" => "list_subscriptions", "iq" => "2" ); // Las variables POST $POST_VARS = array();
Generando salt, timestamp, signature y enviando la solicitud
*** El siguiente bloque de código es común para todas las solicitudes firmadas ***
// Recopilando la información del API y URL Base $API_URL = "https://www.midominiowebtv.tv/api.php"; $API_KEY_ID = "1b323a1cb879fd4e66530fbad07a32ee"; $API_SHARED_SECRET = "MWIzMjNhMWNiODc5ZmQ0ZTY2NTMwZmJhZDA3YTMyZWViOTQ3MDJiOGM2ZTU2NjE3"; // Mantenga esto en un lugar seguro!!! // Generando salt y timestamp $salt = md5(mt_rand()); $timestamp = time(); // Generando la firma de validación // - Método por defecto: usando base64_encode(hash_hmac(...)) $signature = base64_encode(hash_hmac('sha256', $salt.$timestamp, $API_SHARED_SECRET, true)); // comentar esta línea si se utiliza el otro método // - Método simplificado - disponible desde v60: usando md5(). // Este método requiere que la variable $API_SIGNATURE_GENERATION_MODE = 1; en el archivo config/Config.inc.php.
// $signature = md5($salt."-".$timestamp."-".$API_SHARED_SECRET); // debe "des-comentar" esta línea si se utiliza el método simplificado // Añadiendo timestamp, salt, key y signature a las variables GET $GET_VARS["timestamp"] = $timestamp; // UTC timestamp $GET_VARS["salt"] = $salt; $GET_VARS["key"] = $API_KEY_ID ; // The API Key ID: This is public and is used by the API to identify the application; $GET_VARS["signature"] = $signature; // Creando la URL de la solicitud. Tenga presente que si no utiliza la función interna de PHP // para crear la solicitud HTTP entonces no se olvide de codificar los valores con URL Encode $REQUEST_URL = $API_URL."?".http_build_query($GET_VARS); // Lo anterior construirá una URL del como .../api.php?go=api_subject&do=api_action&etc... // Creando un recurso cURL con las opciones apropiadas $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $REQUEST_URL); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HEADER, false); curl_setopt($ch, CURLOPT_POSTFIELDS, $POST_VARS); // If your PHP host does not have a valid SSL certificate, you will need to turn off SSL // Certificate Verification. This is dangerous (!), and should only be done temporarily // until a valid certificate has been installed curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); // Turns off verification of the SSL certificate. curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Turns off verification of the SSL certificate. // Enviando la solicitud al API $response = curl_exec($ch); // Procesando la respuesta if (!$response) { echo 'Llamada al API falló'; } else { print_r(json_decode($response,true)); }