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

API.updateBooks

Cette action vous permet de mettre à jour un ou plusieurs documents de votre souscription.

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
documents

Tableau contenant les documents à publier.

Chaque document est un tableau comprenant les éléments suivants (l'ordre n'a pas d'importance) :

Requis:

  • Code  : Clé unique d'identification de la publication fournie dans la page « Vos publications »

Facultatifs (Les valeurs utilisées par défaut sont soulignées) :

  • CID : Identifiant du fichier uploadé, nécessaire si vous souhaitez publier une nouvelle version du document. Voir l'exemple de code ci-dessous.
  • CategoryReference : Catégorie de la publication:
     
    • Divers: MISC
    • Actualités: NEWS
    • Arts & Design: ARTS
    • Automobiles: AUTO
    • Business: BUSINESS
    • Cinéma: MOVIES
    • Culture: CULTURE
    • Éducation: SCHOOL
    • Voyages: TRAVEL
    • Humour: HUMOR
    • Jeux vidéos: VIDEOGAMES
    • Juridique: LAW
    • Littérature: LITERATURE
    • Musique: MUSIC
    • Nature: NATURE
    • Politique: POLITICS
    • Religion: RELIGION
    • Santé: HEALTH
    • Sciences: SCIENCES
    • Sexy: SEXY
    • Société: PEOPLE
    • Sports: SPORTS
    • Technologie: TECH

 

  • FormatReference : Format de la publication:
     
    • Divers: MISC
    • Albums: ALBUMS
    • B.D. : BD
    • Brochures: BROCHURES
    • Catalogues: CATALOGS
    • Comics: COMICS
    • Journaux: NEWSPAPERS
    • Livres: BOOKS
    • Magazines: MAGAZINES
    • Mangas: MANGAS
    • Manuels: MANUALS
    • Multimédia: MULTIMEDIA
    • Partitions: SHEETMUSIC
    • Présentations: PRESENTATIONS
    • Rapports: REPORTS
    • Romans: NOVELS

 

  • DialectReference : Langue de la publication, sous la forme d'un code à 2 lettres ISO-639-1, ou bien inconnu: UNKNOWN
  • Name : Titre de la publication (si vide, le nom de fichier sera utilisé)
  • Description : Description de la publication
  • Date : Date de la publication
  • IsPublished : Activation de la publication (true ou false)
  • PublishingMode : Mode d'accès (public: 1, privé: 2)
  • PrivateUrlMode : Création d'une URL privée (oui: 1 ; non: 0)
  • SubscribingMode : Autoriser l'accès aux abonnés (oui: 1 ; non: 0)
  • CommentingMode : Traitement des commentaires (Aucun commentaire: 0, modérer tout: 1, modérer sauf les contacts: 2, accepter que les contacts: 3, accepter tous: 4)
  • DownloadingMode : Autoriser le téléchargement (Non: 0, que les contacts: 1, oui: 2)
  • MiniMode : Autoriser la création du MiniCalaméo (oui: 1 ; non: 0)
  • AdultMode : Publication réservée aux adultes (oui: 1 ; non: 0)
  • ReadingMode : Sens de lecture (De gauche à droite: 0, de droite à gauche: 1)
  • LicensingMode : Licence (aucune: laisser vide ; pd (domaine public) ; Creative commonsby / by_nc / by_nc_nd / by_nc_sa / by_nd / by_sa)
  • LogoUrl : Url du logo personnalisé
  • LogoLink : Lien du logo personnalisé
  • BackgroundUrl : Url de l'arrière-plan personnalisé
  • MusicUrl : Url de l'ambiance sonore personnalisée
  • MusicMode : Mode de l'ambiance sonore (en boucle: 0, une fois:1)
  • SoundEffectMode : Jouer les effets sonores (oui: 1 ; non: 0)
  • FlipSoundUrl : Url d'un effet sonore de changement de page personnalisé

Réponse

Cette requête retourne un tableau contenant une ligne par document mis à jour, chaque ligne étant un tableau ayant pour clé le n° du document dans la requête initiale (à partir de 1) et comprenant les éléments suivants

Type "Success" si la mise à jour a eu lieu, "Error" dans le cas contraire
CID Identifiant du fichier uploadé, le cas échéant.
Message Texte confirmant le succès ou détaillant l'erreur.
Book

En cas d'échec, absent.

En cas de succès, tableau contenant les éléments suivants:

  • 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
  • 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.
  • 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
ErrorCode Code d'erreur. Vide en cas de succès.

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

Exemple

<!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>Màj de publications</title>
</head>
<body>
<?php
include_once('nusoap.php');
include_once('nusoap_mime.php');
$client = new nusoap_client_mime('http://www.calameo.com/api/?wsdl', true);
$client->setHTTPEncoding('gzip, deflate');
$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 = 'API.updateBooks';
// Un premier document avec une nouvelle version de fichier    
$cid1 = $client->addAttachment('', 'c:/mon_premier_document.pdf');
$doc1 = array(
'CID'		=> $cid1,
'Code'          => '0000000006589874562',
'Name'		=> 'Mon premier document',
'Description'	=> 'Ceci est un premier document',
'Date'		=> '2007-12-24',
'IsPublished'	=> true,
'PublishingMode'=> 2,
'AdultMode'	=> 1
);
// Un second document sans nouvelle version de fichier    
$doc2 = array(
'Code'          => '0000000006589874562',
'Name'		=> 'Mon second document',
'Description'	=> 'Ceci est un premier document',
'Date'		=> '2004-12-24',
'IsPublished'	=> false,
'PublishingMode'=> 1
);
$params = array (
'api_key'		=> '123346544abdefbca1546854',
'login'		=> 'email@moncompte.com',
'md5_pwd'		=> 'd4f7ccab36fbfedc5f53e09d20d6973a',
'subscription_code'	=> '05511df55155d5a5bc5',
'documents'	        => array($doc1, $doc2)
);
$result = $client->call($message, $params);
if ($client->fault) {
// Une erreur est survenue
die('Une erreur est survenue !');
} else {
// Vérifie si une erreur SOAP n'a pas été renvoyée
$err = $client->getError();
if ($err) {
// Affiche l'erreur
echo 'SOAP Error: ' . $err ;
} else {
// Tout s'est bien passé, vous pouvez traiter le résultat => $result
echo '<pre>';
echo 'documents publiés avec succès!';
echo '</pre>';
}
}
?>
</body>
</html>