users > create | Referencia API WS.WebTV | WebTV Solutions

Imprimir

Construyendo la Solicitud

URL de la Solicitud y Variables GET

Variables GET específicas para esta solicitud:

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=users&do=create&{información requerida}

Variables POST

La siguientes variables POST son requeridas.

Caso 1 - Registro estándar:

Caso 2 - Registro usando un proveedor de login externo (WS.WebTV 1.8.5+):

La siguientes variables POST son opcionales pero requiren la extensión Gestión Avanzada de Usuarios.

Ejemplos de Respuesta

Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• ok: Si el Usuario fue creado (registrado) exitosamente.
• id: El ID del Usuario.
• activation_key: La clave de activación.
Ejemplo:

{
    "ok": "User was registered successfully",
    "id": 78,
    "activation_key": "bj8g3dz5xsntprsy0icc"
}

Si la solicitud no es exitosa (por ejemplo, si el Nombre de Usuario/Login es inválido), recibirá una respuesta como la siguiente:

{
    "error": "REGISTRATION_ERROR",
    "error_long": "Invalid login"
}

Posibles Mensajes de Error
Además de los errores generales, esta solicitud puede devolver los siguientes errores:

• REGISTRATION_ERROR | {Mensaje}:
No fue posible crear (registrar) el Usuario por la razón especificada.

Ejemplo de Código en PHP

Preparando los datos GET y POST.

// The GET vars
$GET_VARS = array( 
					"go"        => "users",
					"do"        => "create"
					);

// The POST vars
$POST_VARS = array(
					"login" => "mrbean",
                    "password" => "123",
                    "alias" => "Mr. Bean",
                    "email" => "mrbean@beanmail.bean", 
                    "notify_webmaster" => 1, // Enviar E-Mail de notificación al Webmaster
                    
                    // ----- Campos opcionales (se requiere ext. Gestión Avanzada de Usuarios)
                    "status" => 2, // Pendiente de verificación
                    "send_user_verification_email" => 1, // Enviar E-Mail de verificación al Usuario
                    "store_post_registration" => 1, // Permitir a la extensión Tienda realizar proceso post-registro
                    "access_level" => 5, // 5 (Suscriptor gratuito)
                    "cms_access" => 1, // 1 Se permite el acceso al Administrador de Contenidos
                    "name" => "Rowan", // El nombre real del Usuario
                    "surname" => "Atkinson ", // El/los apellidos del Usuario
                    "gender" => 1, // 1 (hombre)
                    "birthdate_y" => 1955, // Fecha de nacimiento: año
                    "birthdate_m" => 1, // Fecha de nacimiento: mes
                    "birthdate_d" => 6, // Fecha de nacimiento: día
                    "company" => "",
                    "address" => "",
                    "postal_code" => "",
                    "vat" => "",
                    "country" => England"",
                    "telephone" => "",
                    "web" => "http://www.mrbean.com/",
                    "notes" => "",
                    "avatar_display" => 3, // 3 (Gravatar, Monsterid)
                    "reg_referer" => "external api",
                    "reg_ip" => "xxx.xxx.xxx.xxx",
                    "reg_useragent" => "",
                    "social_page_facebook" => "http://www.facebook.com/MrBean",
                    "social_page_googleplus" => "",
                    "social_page_twitter" => "https://twitter.com/MrBean",
                    "social_page_linkedin" => "", 
                    "social_page_flickr" => "", 
                    "social_page_vkontakte" => "",
                    "social_page_tuenti" => "",
                    "social_page_other" => "",
                    "profile_page_privacy" => 0, // Página de perfil del Usuario es público
                    "profile_page_about" => "Rowan Atkinson’s comic acting genius has created a highly original work for television. The Mr Bean series has been sold to 190 territories worldwide and has won an International Emmy and the Golden Rose of Montreux",
                    "profile_page_show_country" => 1, // Mostrar el país del Usuario en la página de perfil
                    "profile_page_show_web" => 1, // Mostrar el Sitio Web del Usuario en la página de perfil
                    "profile_page_show_social" => 1 // Mostrar los enlaces a los perfiles sociales del Usuario en la página de perfil
                    );

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)); 
}