Legales

API (GridPanel)

El GridPanel cuenta con un API que permite acceder a todas sus funciones desde cualquier lenguaje de programación para integrar en tu sitio y explotar al máximo el servicio.

A través del API se puede, por ejemplo, crear usuarios de Correo o FTP, ver las estadísticas del sitio, modificar la clave de una base de datos o inclusive dar de alta nuevas cuentas.

[editar] Funciones Disponibles

Todas las funciones reciben parámetros de tipo escalar, ya sea enteros o cadenas de caracteres. En caso de enviar una matriz, cada elemento de la matriz se va a tomar como un parámetro distinto.

[editar] Estadisticas

estadisticas.web.ver (puntero, año, mes, seccion) seccion debe tener la forma awstats.host.seccion.html (ver Ejemplo)

Devuelve un HTML con las estadisticas Web para el Puntero elegido, en un año y mes determinado.

estadisticas.web.resumen (host, año, mes)

Devuelve una matríz con la información de estadística Web resumida para el mes elegido.

estadisticas.web.meses

Devuelve una matriz con los meses para los cuales hay estadisticas disponibles.

[editar] FTP

Artículo principal API FTP

ftp.agregar (usuario, clave, ruta)

Agrega un usuario FTP a la Cuenta. La ruta es relativa a la raiz ('/') del sitio.

Devuelve 1 o 0 según el éxito de la operación

ftp.eliminar (usuario)

Eliminar un FTP de la Cuenta.

Devuelve 1 o 0 según el éxito de la operación

ftp.chpass (usuario, nueva clave)

Cambia la clave de un usuario FTP

Devuelve 1 o 0 según el éxito de la operación

[editar] Correo

Artículo principal API Correo

email.usuarios.agregar (usuario, clave)

Agrega un usuario de correo

Devuelve 1 o 0 según el éxito de la operación

email.usuarios.eliminar (usuario)

Elimina un usuario de correo

Devuelve 1 o 0 según el éxito de la operación

email.usuarios.setopt (usuario, opcion)

email.usuarios.unsetopt (usuario, opcion)

Define o Elimina una de varias opciones posibles para un usuario de Correo. Las opciones son:

CANRECEIVE: Permite que el usuario almacene los correos que recibe (Usuario Normal). Sin esta opción, la casilla de correo es un Alias

SMTPMAILING: Permite que el usuario utilice el servicio de envíos masivos por el puerto 2525

ANTISPAM_BAY: Habilita el filtro Antispam bayesiano para el usuario de correo

email.usuarios.chpass (usuario, nueva clave)

Cambia la clave de acceso de un usuario de correo

Devuelve 1 o 0 según el éxito de la operación

[editar] Ejemplos de Uso

[editar] PHP

Ver el resumen de Uso Web

<?php
include('GP.php'); // Esta librería está disponible de forma global
 
$micuenta = 'ejemplo';
$miusuario = 'admin';
$miclave = 'test';
$midominio = 'dominio.com';
 
$gp = GP_open(); // Devuelve un objeto de acceso al GridPanel
$gp->connect(); // Hay que conectarse al servicio
 
// Primero nos identificamos
if(!$gp->call('log.in',$micuenta, $miusuario, $miclave))
{
    print "Error de Acceso: ".$gp->faultString."<br />\n";
    $gp->disconnect();
    exit;
}
print "<pre>\n";
print_r($gp->call('estadisticas.web.resumen',$midominio,'YYYY','MM')); // Por ej. YYYY = 2007, MM = 05
print "</pre>\n";
 
$gp->disconnect(); // No olvidar desconectarse al finalizar
?>

Agregar un Usuario FTP

<?php
include('GP.php'); // Esta librería está disponible de forma global
 
$micuenta = 'ejemplo';
$miusuario = 'admin';
$miclave = 'test';
 
$gp = GP_open(); // Devuelve un objeto de acceso al GridPanel
$gp->connect(); // Hay que conectarse al servicio
 
// Primero nos identificamos
if(!$gp->call('log.in',$micuenta, $miusuario, $miclave))
{
    print "Error de Acceso: ".$gp->faultString."<br />\n";
    $gp->disconnect();
    exit;
}
print "<pre>\n";
print_r($gp->call('ftp.agregar','usuario','clave','ruta')); // Por ej. usuario = micasa, clave = test, ruta = '/htdocs'
print "</pre>\n";
 
$gp->disconnect(); // No olvidar desconectarse al finalizar
?>

Ver las Estadisticas sin Acceder al Panel de Control

<?php
include('GP.php'); // Esta librería está disponible de forma global
 
// Configuracion
$anioactual = date("Y"); // Tomamos el Año actual
$mesactual =  date("m"); // Tomamos el Mes actual
$micuenta = 'micuenta'; // El nombre de la cuenta con la que validamos en el Panel, para las estadisticas podemos crear un Usuario con esos permisos nada mas.
$miusuario = 'usuario'; // Del panel, Ej: estadisticas si lo creamos como recomiendo en el punto anterior.
$miclave = 'clave'; // Clave no hay mucho para aclarar
$midominio = $_SERVER["SERVER_NAME"]; // Si la direccion de esta pagina esta en el mismo sitio del que queremos ver las estadisticas de esta forma nos ahorramos una variable.
$mihtml = 'awstats.'.$midominio.'.html'; // Este es el nombre de la pagina que llamamos
 
 
$gp = GP_open(); // Devuelve un objeto de acceso al GridPanel
$gp->connect(); // Hay que conectarse al servicio
 
// Primero nos identificamos
if(!$gp->call('log.in',$micuenta, $miusuario, $miclave))
{
    print "Error de Acceso: ".$gp->faultString."<br />\n";
    $gp->disconnect();
    exit;
}
 
//Nos fijamos si tenemos algun parametro interno o mostramos la pagina por defecto
if(isset($_REQUEST[s]))
{
        $mihtml = $_REQUEST[s];
        newurl($midominio,$mihtml,$anioactual,$mesactual,$mihtml);
}
else
{
        $mihtml = 'awstats.'."$midominio".'.html';
        newurl($midominio,$mihtml,$anioactual,$mesactual,$mihtml);
}
 
// Esta funcion la necesitamos para ir trayendo los datos de las distintas secciones, esto sale de los links del la pagina principal.
 
function newurl($midominio,$mihtml,$anioactual,$mesactual,$mihtml)
{
                global $gp;
                $html = $gp->call('estadisticas.web.ver', $midominio, $anioactual, $mesactual, $mihtml);
                $html = preg_replace('/<a href="(.*?)" target="awstatsbis">/','<a href="'.$_SERVER["SCRIPT_NAME"].'?s=$1" target="_blank">', $html);
                echo $html;
}
 
 
$gp->disconnect(); // No olvidar desconectarse al finalizar
?>