API.renewBookPrivateUrl

Cette action vous permet de regénérer une nouvelle URL privée pour une publication. En cas de succès, l'ancienne URL privée sera immédiatement invalidée.

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
book_code Clé unique d'identification de la publication fournie dans la page « Vos publications »

Réponse

Cette requête retourne un tableau comprenant les éléments suivants

Type "Success" si l'ajout a eu lieu, "Error" dans le cas contraire
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>Publication de documents</title>
</head>

<body>
<?php

    include_once('nusoap.php');
    
    $client = new nusoap_client('http://api.calameo.com/?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 = 'API.renewBookPrivateUrl';

    $params = array (
		    'api_key'		=> '123346544abdefbca1546854',
		    'login'		=> 'email@moncompte.com',
		    'md5_pwd'		=> 'd4f7ccab36fbfedc5f53e09d20d6973a',
		    'subscription_code'	=> '05511df55155d5a5bc5',
		    'book_code'         => '000001a1d2b21c15f52',
		    );

    $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 'URL privée renouvelée avec succès!';
            echo '</pre>';
        }
    }

?>
</body>
</html>

 

Customer service discussions
Loading...