UpdateSubscriberData. Editar los datos del contacto existente

Puede cambiar los datos de contacto existentes solicitando una consulta al servicio API utilizando métodos de software. Puede cambiar el nombre del contacto, el número de teléfono y la ciudad de residencia.

Puede cambiar los datos de cada contacto una vez usando la función.

La consulta se envía por el método POST en formato URLencode a la dirección: https://username.soloclic.com/api/UpdateSubscriberData.

Donde username es el inicio de sesión del usuario en el sistema, así como su dominio de tercer nivel en el servicio SoloClic.

Parámetros transferidos en la consulta

• lead_email es el correo electrónico del contacto existente (obligatorio);
• lead_name es el nuevo nombre del contacto después de realizar la consulta (opcional);
• lead_phone es el número de teléfono que será reemplazado por el ya especificado (no necesariamente);
• lead_city es la ciudad de contacto (opcional);
• lead_tags es la etiqueta (o etiquetas) del contacto (opcional).

El campo lead_email es el único campo obligatorio. Los otros campos dependen de usted. Si se rechaza el campo, los datos del usuario en este campo permanecen sin cambios.

¿Como funciona?

Usted transfiere el correo electrónico del contacto y los nuevos datos a la función de API UpdateSubscriberData para reemplazar los antiguos.

Su sistema recibirá el resultado de la función como respuesta. La respuesta está codificada en formato JSON. Para obtener más detalles, consulte las «Respuestas del servicio API«.

Ejemplo de cambio de datos de contacto en PHP

En el ejemplo, cambiamos los datos de contacto con el correo electrónico «[email protected]». El inicio de sesión en el sistema es «nombre de usuario».

La función GetHash forma el hash de los datos transferidos.

La función CheckHash comprueba el hash de la respuesta del servicio.

 // Inicie sesión en el sistema SoloClic.
 $user_rs['user_id'] = 'username';
 // La clave para formar un hash. Consulte la sección API (el enlace en la esquina inferior derecha de la cuenta personal).
 $user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
 
 // Formando la matriz de datos para transferir a la API.
 $send_data = array(
    'lead_email' => '[email protected]', // el nombre del suscriptor existente.
    'lead_name' => 'John', // el nombre de reemplazo.
    'lead_phone' => '+18000000000', // nuevo número de teléfono.
    'lead_city' => 'Los Angeles', // ciudad de residencia.
    'lead_tags' => 'tag1,tag2,tag3', // etiquetas de suscriptor.
 );

// Formando el hash a los datos transmitidos.
$send_data['hash'] = GetHash($send_data, $user_rs);

// Llamar a la función UpdateSubscriberData en la API y decodificar los datos recibidos.
$resp = json_decode(Send('https://username.soloclic.com/api/UpdateSubscriberData', $send_data));

// Comprobando la respuesta del servicio.
if(!CheckHash($resp, $user_rs)){
    echo "¡Error! ¡El hash de respuesta no es válido!"; print_r($resp);
    exit;
}

if($resp->error_code == 0)
    echo "Los datos del suscriptor se actualizan: {$resp->error_text}";
else
    echo "Código de error:{$resp->error_code} - descripción: {$resp->error_text}";

// =========== Funciones de enviar, recibir y procesar una respuesta ============

// Envío de la consulta al servicio API
function Send($url, $data)
{
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // dando salida a la respuesta a la variable

    $res = curl_exec($ch);

    curl_close($ch);
    return $res;
}

// Formando el hash de datos transferidos a la API
function GetHash($params, $user_rs) {
    $params = http_build_query($params);
    $user_id = $user_rs['user_id'];
    $secret = $user_rs['user_rps_key'];
    $params = "{$params}::{$user_id}::{$secret}";
    return md5($params);
}

// Comprobando el hash de respuesta recibido.
function CheckHash($resp, $user_rs) {
    $secret = $user_rs['user_rps_key'];
    $code = $resp->error_code;
    $text = $resp->error_text;
    $hash = md5("$code::$text::$secret");
    if($hash == $resp->hash)
        return true; // el hash es correcto.
    else
        return false; // el hash no es correcto.
}