API.searchSubscriptionBooks
Esta acción le permite recuperar todas o parte de las publicaciones de una suscripción.
Solicitud
| api_key | Usar su clave de API |
| login | Usar la dirección de correo electrónico del perfil de una cuenta que tiene acceso a las APIs. |
| md5_pwd | Usar la contraseña del perfil, codificada en formato MD5. |
| subscription_code |
Usar el código API proporcionado en la página « Sus suscripciones », o recuperado por la API getAccountSubscriptions |
| query |
Cadena de caracteres a buscar. |
| order (opcional) | Cadena de caracteres utilizada para definir los criterios de las publicaciones. Los valores posibles son:
|
| way (opcional) | Cadena de caracteres utilizada para definir el orden de clasificación. Los valores posibles son:
|
| start (opcional) | Posición inicial del intervalo de publicaciones enviadas. |
| step (opcional) | Número de publicaciones a enviar desde la posición inicial. |
Respuesta
Esta solicitud envía una tabla que contiene las publicaciones solicitadas con la información siguiente:
| Code |
Clave de identificación única para la publicación |
| Name | Título de la publicación |
| Description | Descripción de la publicación. |
| IsPrivate | Envía 1 si la publicación es privada y 0 si no lo es. |
| AllowMini | Envía 1 si la publicación permite el acceso a la miniCalaméo y 0 si no. |
| Pages | Número de páginas de la publicación. |
| Width | Ancho de una página de la publicación. |
| Height | Largo de una página de la publicación. |
| Date | Fecha de cita de la publicación. |
| Creation | Fecha de creación de la publicación |
| Modification | Fecha de la última modificación de la publicación. |
| PictureUrl | URL absoluta para la portada de la publicación |
| ThumbUrl | URL absoluta para la imagen en miniatura de la publicación. |
| PublicUrl | URL absoluta para la información general de la publicación. |
| ViewUrl | URL absoluta para la página de lectura de la publicación. |
| CommentsUrl | URL absoluta para los comentarios de la publicación. |
Se devuelve un mensaje de error en caso de problemas.
Ejemplo
Este ejemplo muestra cómo recuperar las 10 publicaciones más leídas de una suscripción:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The most read of my publications</title>
</head>
<body>
<?php
include_once('nusoap.php');
$client = new soapclient('http://api.calameo.com/?wsdl', true);$err = $client->getError();
if ($err) {
// Mostrar los errores
echo 'SOAP Error: ' . $err;
// Si ocurre un error, es inútil continuar
die('¡Ha ocurrido un error!');
}
$message = 'API.fetchSubscriptionBooks';
$params = array (
'api_key' => '123346544abdefbca1546854',
'login' => 'email@myaccount.com',
'md5_pwd' => 'd4f7ccab36fbfedc5f53e09d20d6973a',
'subscription_code' => '05511df55155d5a5bc5',
'order' => 'Views',
'way' => 'DOWN',
'start' => 0,
'step' => 10
);
$result = $client->call($message, $params);
if ($client->fault) {
// Ha ocurrido un error
die('¡Ha ocurrido un error!');
} else {
// Verifique si no se ha devuelto un error SOAP
$err = $client->getError();
if ($err) {
// Mostrar el error
echo 'SOAP Error: ' . $err ;
} else {
// Proceso satisfactorio, puede procesar el resultado => $result
echo '<ol>';
foreach ( $result as $book ) {
echo '<li>';
echo '<a href="' . $book['PublicUrl'] . '">';
echo $book['Name'];
echo '</a>';
echo '</li>';
}
echo '</ol>';
}
}
?>
</body>
</html>
