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

API.reviseBooksFromText

This action allows you to revise one or several publications directly from plain text.

Request

api_key Use your API key
login Use the e-mail address of an account profile that has access to the APIs.
md5_pwd Use the password from the profile, encrypted in MD5 format.
subscription_code Use the API code supplied in the “Your subcriptions” page, or recovered by the getAccountSubscriptions API
documents

Table with the documents to publish.

Each document itself is a table which contains the following elements (the order is of no importance):

Required:

  • Text : Plain text to convert into a publication.
  • Code : Unique identifier of the publication.

Response

This request returns an array with one line per published document, the key of which being an counter starting from 1. Each line is an array with the following information:

Type "Success" or "Error"
Message Texte confirming the success or explaining the error.
Book

In case of failure, not present.

In case of success, array with the following elements:

  • Code : Unique identifying key for the publication.
  • Name : Title of the publication.
  • Description : Description of the publication.
  • IsPrivate : Sends 1 if the publication is private and 0 if not.
  • AllowMini : Sends 1 if the publication allows access to the miniCalaméo and 0 if not.
  • Date : Date of citation of the publication.
  • Creation : Date of creation of the publication.
  • Modification : Date of the last modification of the publication.
  • PublicUrl : Absolute URL for the publication’s overview.
  • ViewUrl : Absolute URL for the publication’s reading page.
  • CommentsUrl : Absolute URL for the publication’s comments.
ErrorCode Error code. Empty if success.

An error message is sent back in case of problems.

Example

<!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>Publish documents</title>
</head>

<body>
<?php

    include_once('nusoap.php');
    
    $client = new nusoap_client('http://api.calameo.com/?wsdl', true);

    $err = $client->getError();
	 
    if ($err) {
       // Display the errors
       echo 'SOAP Error: ' . $err;
       // If an error occurs, it's useless to continue
       die('An error has occurred!');
    }

    $message = 'API.reviseBooksFromText';

    $doc1 = array(
					'Text'		=> 'My first text',
					'Code'		=> '000001e2111551f51c515afb'
				);
				
    $doc2 = array(
					'Text'		=> 'My second text',
					'Code'		=> '000001e2151f545345fab5ae'
				);
				
				

    $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) {
        // An error has occurred
        die('An error has occurred!');
    } else {
        // Verify if a SOAP error wasn’t sent back
        $err = $client->getError();
        if ($err) {
            // Display the error
	    echo 'SOAP Error: ' . $err ;
        } else {
	    // All went well, you can process the result => $result
            echo '<pre>';
            echo 'Books successfully created!';
            echo '</pre>';
        }
    }

?>
</body>
</html>