Versión API v2.0
Asigna saldo desde una cuenta principal a una cuenta hija
https://restapi.marketext.com/topup/{api_id_source}/{api_id_target}
Nuestra API Rest utiliza un esquema de autenticación basado en esta especificación OAuth 2.
Todas las solicitudes de envío deberán incluir el encabezado Authorization con el siguiente formato:
Authorization: Token ASDFGHJKLZXCVBNMQWERTYUIOP1234567890==
Parámetro | Descripción | Requerido | Valor Predeterminado |
---|---|---|---|
user | ID del usuario de la cuenta principal que realiza la asignacion | Obligatorio | |
amount | Cantidad de puntos a asignar (No se permiten valores negativos) | Obligatorio |
POST | http://restapi.marketext.com/topup/main_account_id/child_account_id?user=username&amount=5000 |
$headers = array('Authorization: Token ec120228fa6fd17e2545703b4cd3eba2gGYlFChF2R2k0ecCS2HluJpjRuonl8LsdBhO9Ne96j8=');
$data=array('user'=>'username', 'amount'=>'5000' );
$client = new RESTClient();
$client->setHeaders($headers);
$client->setData($data);
$client->setUrl("http://restapi.marketext.com/topup/main_account_id/child_account_id");
$client->setMethod("POST");
$client->execute();
$response = $client->getLastResponse();
$client->resetClient();
Respuesta esperada | Parámetro a enviar |
---|---|
JSON | application/json |
XML | application/xml |
CSV | text/csv |
Form URL Encoded | application/x-www-form-url-encoded |
JSON{ "status" => "OK" }XML<?xml version="1.0"?> <respuesta><status>OK</status></respuesta>CSVOKURLEncodedstatus=OK
La siguiente es una lista de códigos de respuesta del recurso y la frase estándar asociadas a ese código, más la explicación de los errores específicos que puedan generarse.
Las frases estándares están destinadas a dar una descripción intutiva del estatus, y la explicación específica permitirá encontrar el error más fácilmente.
El código de respuesta es enviado en el encabezado, y la explicación en el cuerpo de la respuesta.
Código | Descripción |
---|---|
400 | Solicitud incorrecta. La solicitud contiene datos no válidos o faltantes. user no definido. amount no definido |
401 | No autorizado. Error de autenticación o no se proporciono la información de autenticación. saldo insuficiente |
404 | No encontrado. El URI no coincide con ninguno de los recursos disponibles, o, si solicita un recurso con un identificador, el recurso no existe. No encontrado. El recurso no existe. |
405 | Método no permitido. El método de la petición HTTP que esta intentando utilizar no esta permitido. Verifique la documentación para ver los metodos permitidos. |
JSON
{
"error": "No autorizado. Error de autenticación o no se proporcionó la información de autenticación"
}
XML
<?xml version="1.0"?>
<respuesta>
<error>No autorizado. Error de autenticación o no se proporcionó la información de autenticación</error>
</respuesta>
CSV
No autorizado. Error de autenticación o no se proporcionó la información de autenticación
URLEncoded
error=No encontrado. El URI no coincide con ninguno de los recursos disponibles, o, si solicita un recurso con un identificador, el recurso no existe -> No encontrado. El código buscado no existe
Transferencia limitada | No |
Formato de la respuesta | JSON/XML/CSV/URLencoded |
Autenticación | Bearer Token Authentication Basada en esta especificación OAuth 2 |