Añadiendo una transacción de pago al pedido en curso.
soporte, ws.webtv, api, tienda, pago, añadir
Variables GET específicas para esta solicitud:
Var | Valor | Descripción |
go | store | La sección del API |
do | add_payment | 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=add_payment&iq={id_usuario}&{información requerida}
La siguientes variables POST son requiridas.
Var | Valor | Descripción |
amount | (decimal) Cantidad | Cantidad que se ha cobrado al Usuario. |
La siguiente variable POST es opcional.
Var | Valor | Descripción |
description | (string) Descripción | La descripción de la transacción (recomendamos incluir el ID del pago, si aplica). |
Si la solicitud es exitosa, recibirá una respuesta conteniendo:
• ok: ...
Ejemplo:
{ "ok" : "Payment was added" } |
Si la solicitud no es exitosa (por ejemplo, si no suministró una firma con la solicitud), recibirá una respuesta como la siguiente:
{ "error" : "REQUEST_ERROR" , "error_long" : "Missing signature" } |
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.
• REQUEST_ERROR | Invalid amount:
No se especificó la cantidad o es menor o igual que 0 (cero).
• ERROR_NO_ORDER | User does not have any current order:
No se puede añadir pago porque el Usuario no tiene un pedido en curso.
• ERROR_AMOUNT_TOO_BIG | Amount can't be higher than order amount due:
La cantidad no puede ser superior al importe a pagar.
Preparando los datos GET y POST.
1 2 3 4 5 6 7 8 9 10 11 12 | // Las variables GET $GET_VARS = array ( "go" => "store" , "do" => "add_payment" , "iq" => "2" ); // Las variables POST $POST_VARS = array ( "amount" => 4.50, "description" => "Payment trough SuperGateway, ID: 154YTR984YX" ); |
Generando salt, timestamp, signature y enviando la solicitud
*** El siguiente bloque de código es común para todas las solicitudes firmadas ***
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | // Recopilando la información del API y URL Base $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.<br> // $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)); } |