Estados, Códigos y Descripciones de respuesta de API

Mensajes de Código y Respuesta de la Tabla API del servicio SoloClic

Después de cada acceso a las funciones del servicio API, su sistema recibe una respuesta en la codificación JSON.

(Para saber cómo obtenerlo y procesarlo, consulte el ejemplo de PHP a continuación.)

En la respuesta, se devuelven los campos error_code, error_text y hash. A veces, la matriz de resultados regresa, cuando es necesario devolver más datos:

• error_code es el código numérico del mensaje de error;
• error_text es un mensaje de error de texto;
• hash es una firma de los datos para asegurarse de que la respuesta sea de nuestro sistema, y no falsificada (para saber cómo se forma, ver más abajo);
• resultes la matriz con los datos del resultado (por ejemplo, result-> bill_id es el número del pedido creado).

La tabla de respuestas se complementará a medida que se desarrolle el servicio API.

Ejemplo en PHP que recibe y procesa la respuesta del servicio

// Inicie sesión en el sistema SoloClic.
$user_rs['user_id'] = 'username'; 

// La clave para formar un hash
$user_rs['user_rps_key'] = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'; 

// Formando la matriz de datos para transferir a la API.
$send_data = array
( 
'rid[0]' => 'super',
'lead_name' => 'Name',
'lead_email' => '[email protected]',
'lead_phone' => '+788888888',
'lead_city' => 'City',
'aff' => 111,
'tag' => 'esto es etiqueta',
'ad' => 1111,
'doneurl2' => 'https://soloclic.com/', ); 

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

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

// Comprobando la respuesta del servicio.
if(!CheckHash($resp, $user_rs))
{ 
echo "¡Error! ¡El hash de respuesta no es cierto!"; 
exit; 
} 
if($resp->error_code == 0) 
echo "Usuario agregado al grupo {$send_data['rid[0]']}. Respuesta de servicio: {$resp->error_code}"; 
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
}