GetPartnerStats. Obtenga las estadísticas del socio

Puede obtener estadísticas de cualquiera de sus socios solicitando una consulta al servicio API utilizando métodos de software.

Su sistema obtendrá una matriz con estadísticas para el socio seleccionado (para un período de tiempo particular).

La consulta es enviada por el método POST en el formato URLencode a la dirección: https://nombre_de_usuario.soloclic.com/api/GetPartnerStats.

Donde nombre_de_usuario 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

• partner – Inicio de sesión del socio (obligatorio)
• date_from – El límite inferior del intervalo de tiempo de las estadísticas, en el formato YYYY-MM-DD (Opcional)
• date_to – El límite superior del intervalo de tiempo para las estadísticas, en el formato YYYY-MM-DD (Opcional)

¿Como funciona?

Llamas a la función API GetPartnerStats.

Su sistema recibirá el resultado de la función que se realiza y una matriz que se verá de la siguiente manera:

Array[
     'earned_total'   => cobrado $,
     'topay_total'    => pagar $,
     'clicks_total'   => número de clics,
     'leads_total'    => número de contactos,
     'bills_total'    => numero de pagos,
     'partners_total' => número de socios,
]

La respuesta está codificada en formato JSON. Para obtener más detalles, consulte las respuestas del servicio API.

Ejemplo en PHP

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'] = 'nombre_de_usuario';
// 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 el conjunto de bienes comprados para transferirlos a la API
$send_data = array(
    'partner'   => 'mi_socio_nombre_de_usuario',
    'date_from' => '2016-08-01',
    'date_to'   => '2016-09-22',
);

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

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

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

if ($resp->error_code == 0){
    echo "Estadísticas de socios:";
    print_r($resp->result);
} 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);
}

// Comprobación del 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
    }
}