|
RECUERDE: Debe solicitar a mediante ticket el ácceso a API de Maxmailer.
Como se provee documentación extensa NO se brinda soporte de ningún tipo sobre este tipo de servicio. Puede consultar sobre el servicio de consultoría opcional (con costo) a nuestros representantes comerciales.
La API utilizan el protocolo HTTP, comúnmente utilizado para la WEB.
Como si fuera una base de datos, usted enviará consulta a Maxmailer y el mismo devolverá los datos correspondiente a esa consulta. Las consultas enviadas a Maxmailer podrán ser de carácter informativo, para recibir información, o bien consultas para la modificación de datos.
Los datos enviados a Maxmailer se harán con el método POST y los datos devueltos en la respuestas estarán en formato JSON.
Las API estan disponibles unicamente para el administrador y los user-manager (o revendedores), salvo las API de suscripción. El uso de estas API requiere de los datos de login del admin o user-manager, segun corresponde (usuario y contraseña).
Todas las funciones requiere de almenos 3 parametros en la consulta POST, que son:
login_username - representando al nombre de usuario del admin o user-manager
login_password - representando la contraseña del admin o user-manager
función - representando el nombre de la función que se desea ejecutar.
En caso de que alguna consulta devuelva un error, la respuesta contendrá el código de error numérico y mensaje de error (en ingles).
En cada función se detallan los parámetros requeridos para la consulta, los valores devueltos y los posibles errores con su correspondiente código numérico.
Algunos ejemplos
Ejemplo en PHP utilizando sockets mediando la libreria "http":
$host = 'www.domain.com'; // Only domain or IP, without http://
$uri = '/mailing/api.php';
$data['login_username'] = 'admin';
$data['login_password'] = 'adminpassword';
$data['function'] = 'ListUsers';
// http.inc.php es la libreria utilizada en el ejemplo que permitira la conexion HTTP a travez de un script PHP.
include "http.inc.php";
$http_client = new http(HTTP_V11, true , true);
$http_client->host = $host;
$http_client->port = 80;
$status = $http_client->post($uri, $data);
if ($status == HTTP_STATUS_OK) {
$data = json_decode($http_client->get_response_body());
print_r($data, true);
} else {
echo "Error connecting to server";
}
$http_client->disconnect();
?>
Ejemplo en PHP utilizando cURL:
$url = 'http://www.domain.com/mailing/api.php';
$data['login_username'] = 'admin';
$data['login_password'] = 'adminpassword';
$data['function'] = 'ChangePassword';
$data['id'] = 15; // ID del usuario al que desea cambiarle la contrase�a
$data['password'] = '123456'; // nueva contrase�a
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data) );
curl_setopt($ch, CURLOPT_HEADER, 0);
$resutl = curl_exec($ch);
curl_close($ch);
$data = json_decode($resutl);
print_r($data, true);
?>
Respuesta a este ejemplo en caso de exito:
stdClass Object
(
[status] => Password changed
)
Respuesta a este ejemplo en caso de error:
stdClass Object
(
[error] => 7002
[message] => Unknow user ID.
)
Ejemplo en Javascript utilizando la libreria Jquery:
// -->
|
