English Français Español
ex. : internet calameo download

API.searchSubscriptionBooks

Cette action vous permet de chercher un terme dans les publications d'une souscription. La recherche s'effectue dans le titre, la description et le contenu des publications

Demande

api_key Utilisez votre clef API
login Utilisez l'adresse e-mail d'un profil du compte ayant accès aux API.
md5_pwd Utilisez le mot de passe du profil encrypté au format MD5.
subscription_code Utilisez le code API fourni dans la page « Vos souscriptions », ou récupéré par l'API getAccountSubscriptions
query

Chaîne de caractères à rechercher.
order (facultatif) Chaîne de caractères utilisée pour définir le critère de classement des publications. Les valeurs possibles sont  :
  • Name : Titre de la publication
  • Pages : Nombre de pages de la publication
  • Comments : Nombre de commentaires de la publication
  • Views : Nombre de lectures de la publication
  • Date : Date de publication
  • Creation : Date de création de la publication
  • Modification : Date de modification de la publication
way (facultatif) Chaîne de caractères utilisée pour définir le sens du classement. Les valeurs possibles sont :
  • UP : Trier par ordre croissant
  • DOWN : Trier par ordre décroissant
start (facultatif) Position de départ de la plage de publications retournée.
step (facultatif) Nombre de publications à retourner à partir de la position de départ.

Réponse

Cette requête retourne un tableau contenant les publications demandées avec les informations suivantes :

Code Clé unique d'identification de la publication.
Name Titre de la publication.
Description Texte descriptif de la publication.
IsPrivate Retourne 1 si la publication est privée et 0 dans le cas contraire.
AllowMini Retourne 1 si la publication permet l'accès au miniCalaméo et 0 dans le cas contraire.
Pages Nombre de pages de la publication.
Width Largeur d'une page de la publication.
Height Hauteur d'une page de la publication.
Date Date de référence de publication.
Creation Date de création de la publication.
Modification Date de la dernière modification de la publication.
PictureUrl URL absolue de la couverture de la publication.
ThumbUrl URL absolue de la miniature de la publication.
PublicUrl URL absolue de la page de présentation de la publication.
ViewUrl URL absolue de la page de lecture de la publcation.
CommentsUrl URL absolue de la page de commentaires de la publication

 

Un message d'erreur est retourné en cas de problème.

Exemple

Cet exemple montre comment récupérer les publications contenant "Calaméo" :

<!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>Mes publications les plus lues</title>
</head>
<body>
<?php
include_once('nusoap.php');
$client = new soapclient('api/?wsdl', true);
$err = $client->getError();
if ($err) {
// Affiche les erreurs
echo 'SOAP Error: ' . $err;
// Si une erreur se produit, il est donc inutile de continuer
die('Une erreur est survenue !');
}
$message =+%27API.searchSubscriptionBooks%27%3B%0D%0A%0D%0A++++%24params+&gt; '123346544abdefbca1546854',
'login'		=&gt; 'email@moncompte.com',
'md5_pwd'		=&gt; 'd4f7ccab36fbfedc5f53e09d20d6973a',
'subscription_code'	=&gt; '05511df55155d5a5bc5',
'query'		=&gt; 'Calam=&eacute;o',
'order'		=&gt; 'Views',
'way'		=&gt; 'DOWN',
'start'		=&gt; 0,
'step'		=&gt; 10
);
$result =+%24client-&gt;call($message, $params);
if ($client-=&gt;fault) {
// Une erreur est survenue
die('Une erreur est survenue !');
} else {
// V=&eacute;rifie si une erreur SOAP n'a pas =&eacute;t=&eacute; renvoy=&eacute;e
$err =+%24client-&gt;getError();
if ($err) {
// Affiche l'erreur
echo 'SOAP Error: ' . $err ;
} else {
// Tout s'est bien pass=&eacute;, vous pouvez traiter le r=&eacute;sultat =&gt; $result
echo '=&lt;ol=&gt;';
foreach ( $result as $book ) {
echo '=&lt;li=&gt;';
echo '=&lt;a href=&quot;' . $book['PublicUrl'] . '=&quot;=&gt;';
echo $book['Name'];
echo '=&lt;/a=&lt;/li=&gt;';
}
echo '=&lt;/ol=&gt;=';
}
}
?>
</body>
</html>