+54 11 5258-8400
Login

Archivo de la etiqueta: PanelBeta

Se viene el nuevo Panel de Control

Estamos a unas semanas de cerrar la etapa de testeos de nuestro nuevo Panel de Control, ¿ya lo probaste?

A partir de Junio  de 2013 estaremos utilizando esta nueva interfaz, mucho más rápida, amigable e intuitiva. Con todas las funcionalidades que ya conocés pero con una performance muy superior.
Si querés saber más acerca de cómo es este nuevo Panel, no te pierdas esta nota!

Y si querés meterte en el Panel Beta, andá a panelbeta.elserver.com

¡Esperamos tus comentarios!

Accediendo a tus estadísticas desde el API

Una de las consultas más frecuentes es la de poder habilitar un usuario especial que tenga acceso solamente a la sección estadísticas. Implementar esto significaría, o bien crear un usuario específico para dicha sección, lo que es demasiado particular, o armar un sistema de ACL que haría la tarea de administrar usuarios y permisos bastante tediosa.

La buena noticia es que a través del API del nuevo panel y la versatilidad que ofrece se puede llevar a cabo en no más de 2 llamadas.

Como hablamos en posts anteriores, el nuevo panel dispone de un API REST que permite ejecutar absolutamente cualquier funcionalidad disponible para la nueva UI desde cualquier lugar. Si, esto quiere decir que si la nueva UI no es enteramente de su agrado y disponen del tiempo, pueden hacer la suya con las mismas exactas funciones. O en este caso, para algo más sencillo como resolver una necesidad puntual.

Ahora si, vamos al código

En primer lugar, lo que debemos hacer es acceder con nuestro SSO y nuestra clave

http://cloudapi.elserver.com/sso/login/?sso=usuario@dominio.com&password=mypassword

Una vez que hicimos esa llamada, obtendremos un access_token para autenticarnos en las futuras llamadas que realicemos.

Ahora bien, una vez que pudimos acceder y tenemos nuestro access_token, podemos ejecutar el pedido de estadísticas que debe ser un GET a /analytics/web/stat/

Eso es todo. Para que les resulte más fácil, les dejo a continuación un ejemplo en php de como se vería la versión final del código:

<?  /******** Begin Configuraciones *********/  $sso = ''; // SSO con el cual accederemos  $password = ''; // Clave del SSO  $account = ''; // Cuenta de la cual queremos obtener las estadisticas  $pointer = ''; // Dominio puntero del cual queremos las estadisticas (por defecto se completara el mismo que la cuenta)  /********* End Configuraciones **********/  $year = date("Y");  $month = date("m");  $pointer = ($pointer == '')? $account : $pointer;  // Me autentico al API  $auth = json_decode(file_get_contents("http://cloudapi.elserver.com/sso/login/?sso=$sso&password=$password"));  if ($auth->error)
    die($auth->error->message);
$access_token = $auth->access_token;

// Pido las estadisticas de la cuenta
$stats = file_get_contents("http://cloudapi.elserver.com/analytics/web/stat/?access_token=$access_token&account=$account&site=$pointer&year=$year&month=$month&type=report");
if (!$stats)
    die('No hay estadísticas para '.$pointer.' en el mes '.$month.' de '.$year);
die($stats);
?>

Para acceder a la documentación completa del API y toda la funcionalidad disponible, pueden acceder a http://www.elserver.com/comunidad/api/

Cómo utilizar el API de ELSERVER.COM: PHP en acción

En un post anterior vimos los conceptos básicos sobre el API de ELSERVER.COM: como listar, crear, modificar y eliminar elementos a través de llamadas HTTP. Sin embargo, no lo aplicamos a ningún lenguaje de programación en particular.

Hoy vamos a avanzar en ese sentido: vamos a ver cómo integrar llamadas al API en nuestras aplicaciones PHP.

Utilizando cURL

Para hacer llamadas HTTP vamos a utilizar la librería cURL, disponible por defecto en toda nuestra plataforma. Si nunca lo utilizaron, pueden investigar más en la documentación oficial.

Como vamos a utilizar cURL muchas veces, nos conviene armar una función que podamos usar de esta forma:

curl($method, $url, $data);

Es bastante intuitivo para qué nos servirá cada argumento:

  • method indicará el método HTTP a utilizar: GET, POST, PUT o DELETE,
  • url será la URL del API con la que queremos contactar,
  • data será un array con los parámetros a enviar en la llamada.

Internamente, esta función se encargará de setear todas las opciones necesarias del objeto cURL, hacer la llamada y retornar el resultado convirtiendo en un array asociativo el JSON que devuelve el API.

El código de esta función podría ser así:

function curl ($method, $url, $data) {

    // Convertimos el array de parametros en un query string
    $data = http_build_query($data);

    // y lo agregamos a la URL en caso de un GET o DELETE
    if (($method === "GET") || ($method === "DELETE")) {
        $url .= '?' . $data;
    }

    // Definimos opciones comunes a todas las llamadas
    $options = array(
        CURLOPT_URL => $url,
        CURLOPT_CUSTOMREQUEST => $method,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HEADER => false
    );

    // Si es necesario, agregamos los parametros al body de la llamada
    if ($data) {
        $options[CURLOPT_POSTFIELDS] = $data;
    }

    // Ejecutamos la llamada
    $call = curl_init();
    curl_setopt_array($call, $options);
    $response = curl_exec($call);
    curl_close($call);

    // Retornamos el resultado como array
    return json_decode($response, true);

}

Perfecto, ya tenemos nuestra función lista. Pueden incluirla en un archivo de helpers o en alguna clase de utilidades comunes, cambiarle el nombre o modificarla como gusten, siempre y cuando tengan acceso simple a ella.

Ahora si, vamos a utilizarla para conectarnos con el API de ELSERVER.

Validando nuestro usuario

Si leyeron el post anterior, deben recordar que para toda acción del API necesitamos un permiso, una llave única que identifique a nuestro usuario: el access_token.

Vamos a obtenerlo:

$login = curl(
    'GET',
    'http://cloudapi.elserver.com/sso/login/',
    array(
        'sso' => 'miusuario@ejemplo.com',
        'password' => 'miclave'
    )
);

Si ejecutamos ese script y hacemos un print_r de $login, podrán ver un resultado como el siguiente:

Array
(
    [access_token] => f049ef54faf3r8245de4469ebd55eb47
    [sso] => miusuario@ejemplo.com
)

¡Vamos bien! Ahora sólo debemos enviar el contenido de $login['access_token'] en todas las llamadas sucesivas.

Pedidos REST

Para seguir con nuestro ejemplo clásico, empecemos por listar las casillas de correo de nuestra cuenta. Pueden hacer la siguiente prueba:

$list = curl(
    'GET',
    'http://cloudapi.elserver.com/email/',
    array(
        'access_token' => $login['access_token'],
        'account' => 'micuenta.com.ar'
    )
);

Cambiando el valor de account por la cuenta deseada, por supuesto.

Si todo salió bien, $list ahora contiene la respuesta que entregó el API, es decir, un array con el listado de cuentas de correo.

Ya se deben imaginar cómo funcionan los llamados de escritura:

Para agregar una casilla de correo:

$create = curl(
    'POST',
    'http://cloudapi.elserver.com/email/',
    array(
        'access_token' => $login['access_token'],
        'account' => 'micuenta.com.ar',
        'user' => 'testermail',
        'password' => 'somepassword'
    )
);

… modificarla:

$update = curl(
    'PUT',
    'http://cloudapi.elserver.com/email/',
    array(
        'access_token' => $login['access_token'],
        'account' => 'micuenta.com.ar',
        'user' => 'testermail',
        'info' => 'Betatester',
        'mailing' => 1
    )
);

… o eliminarla:

$delete = curl(
    'DELETE',
    'http://cloudapi.elserver.com/email/',
    array(
        'access_token' => $login['access_token'],
        'account' => 'micuenta.com.ar',
        'user' => 'testermail'
    )
);

Recuerden que las funciones de escritura devuelven data: 1 en caso de ser exitosas. Por lo que si en el último ejemplo el usuario pudo ser borrado, al hacer un print_r de $delete veremos:

Array
(
    [data] => 1
)

Tareas avanzadas

Con esto resulta muy fácil automatizar tareas frecuentes de nuestra cuenta de hosting. Por ejemplo, podemos programar un script que active la opción de mailing para todos nuestros usuarios de correo:

// Obtenemos nuestro access token
$login = curl(
    'GET',
    'http://cloudapi.elserver.com/sso/login/',
    array(
        'sso' => 'miusuario@ejemplo.com',
        'password' => 'miclave'
    )
);

// Definimos nuestra cuenta y la URL del API
$account = 'micuenta.com.ar';
$url = 'http://cloudapi.elserver.com/email/';

// Obtenemos el listado de casillas de correo
$emails = curl(
    'GET',
    $url,
    array(
        'access_token' => $login['access_token'],
        'account' => $account
    )
);

// Recorremos el listado activando el mailing
foreach ($emails['data'] as $email) {
    $result = curl(
        'PUT',
        $url,
        array(
            'access_token' => $login['access_token'],
            'account' => $account,
            'user' => $email['user'],
            'mailing' => 1
        )
    );

    // Si hubo un error, lo logueamos
    if ($result['error']) {
        $errors[] = $email['user'];
    }
}

// Reportamos si hubo errores
if (!empty($errors)) {
    echo 'Errores al modificar los siguientes usuarios:';
    echo implode($errors);
}

// Si no, retornamos un mensaje feliz
echo 'Finalizado!';

Tengan en cuenta que, si bien nuestro API es muy rápido, cada llamada HTTP toma su tiempo: la ejecución de PHP puede cortarse si superamos el tiempo máximo para un proceso (60 segundos).

Este ejemplo es ilustrativo, si tienen decenas y decenas de casillas de correo conviene hacer el proceso por partes. Para eso en todos los listados pueden utilizar paginado, definiendo:

  • offset, la posición en la que queremos que comience nuestro listado
  • limit, la cantidad de registros a obtener

Por ejemplo, para obtener la primer página de un listado largo podemos definir offset en 0 y limit en 20. Para obtener la segunda definimos offset en 20, para la tercera en 40 y así sucesivamente.

En resumen

Nuestro nuevo API REST maneja todas sus funciones de una forma similar, por lo que pueden consultar en nuestra documentación el resto de los módulos y ponerlos en práctica.

Por ejemplo, pueden agregar autorespuestas para un listado de usuarios de email, crear usuarios FTP temporales, cambiar el horario de ejecución de un cron, descargar backups… todo desde sus propias aplicaciones, utilizando nuestro API.

Si tienen alguna consulta, no duden en escribirnos a desarrollo@elserver.com para que podamos brindarle toda la ayuda que necesiten.

Nuevo panel: Frontstage y Backstage de creación de usuarios de mail

Uno de los aspectos más potentes del nuevo panel de control es la posibilidad de ejecutar cualquier acción a través de nuestro API. Es una de las características fundamentales de nuestra nueva aplicación, al punto tal que la UI (es decir la interfaz del usuario) está desarrollada íntegramente en JavaScript y todo el procesamiento se realiza mediante llamadas al API. Esto quiere decir que cualquier usuario de la plataforma, o que simplemente tengan un usuario SSO, puede crear un Panel de Control con exactamente las mismas funcionalidades.

En este artículo vamos a tomar como ejemplo una acción cotidiana como dar de alta un usuario de mail y ver que es lo que pasa detrás de escena.

Alta de un usuario de mail desde el Panel de Control

Para crear un usuario de mail los pasos son los siguientes:

1- Ingresar al panel de control (http://panelbeta.elserver.com/) con tu SSO.

2- Seleccionar desde la izquierda la cuenta a la que le querés crear un nuevo usuario de mail.

3- Una vez desplegado el menu de la cuenta, hacer click en Emails.

4- En esta sección hacer click en el botón de “Agregar email”.

5- Completar los datos de Usuario y Contraseña del nuevo mail.

6- Hacer click en el botón de “Guardar Cambios”.

Alta de un usuario de mail mediante el API

Para replicar esta misma funcionalidad pero directamente desde el API del Panel de Control, debemos:

1- Validarnos: Para ejecutar cualquier comando en el API debemos tener un Access Token. Para obtenerlo, debemos ejecutar un login en el módulo SSO, que se traduce a lo siguiente:

http://cloudapi.elserver.com/sso/login/?sso=miusuariosso@dominio.com&password=miclavedesso

El resultado será un json con 2 datos: access_token y sso. Almacenemos el primero porque lo necesitaremos para todas las llamadas que hagamos al API.

2- Ejecutar el alta: A diferencia de la UI, el API recibe directamente la cuenta sobre la que vamos a trabajar como un parámetro, no hace falta ejecutar ninguna instrucción de selección de cuenta. El namespace del módulo es /account/email/ y siguiendo los lineamientos de cualquier API REST debemos hacer un POST a esa dirección para agregar un elemento nuevo.

Para cualquier acción que no sea GET, podemos usar cualquier aplicación online o para facilitar las cosas el API soporta que le sobreescriban el método con un argumento del estilo method=POST. Esto último es lo que usaremos en esta oportunidad.

Ya tenemos nuestro access_token, y el namespace y método a donde debemos enviar nuestra información, solo resta elegir nuestro usuario y clave: cosmefulanito@midominio.com y clave eseperrotienelacolapeluda en nuestra cuenta midominio.com. La llamada completa quedaría así:

http://cloudapi.elserver.com/account/email/?account=midominio.com&user=cosmefulanito@midominio.com&password=eseperrotienelacolapeluda&method=POST&access_token=[ACCESS_TOKEN]

Si todo salió correctamente, deberíamos obtener un json con una respuestas {data: 1}. y listo, acabamos de emular la funcionalidad del Panel de Control pero directamente en el API.

Espero que les sirva como introducción al uso de nuestro API. En los próximos días profundizaremos más en los módulos que lo componen y en su utilización.

LAYOUT

SAMPLE COLOR

Please read our documentation file to know how to change colors as you want

BACKGROUND COLOR

BACKGROUND TEXTURE