Get

PreviousDocument NextPost file

Last updated 3 years ago

Was this helpful?

Get

Retrieve an existing document

Parameters:

Name

Optional / Required

Data type

Description

Default

required

Integer

One of your document ids

return_fields

optional

String

Customize the responses by setting the return fields (id, create_date, update_date, url, read_url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code, settings)

id, url, short_url, image_small, image_medium, image_big, language, title, description, tags, embed_code

Demo

URL Find your token on - Token

Optional parameters:

return_fields

Add optional parametersRun request

Example:

curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/document.json?id=27109085"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'id' => 27109085,
    'return_fields' => 'id,create_date,update_date,url,image_small'
);
$listDocument = $yumpu->getDocument($data);
print_r($listDocument);

Example:

var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
   id: 27109085
};
yumpu.getDocument(parameters, function(statusCode, document){
   console.log('Status: ' + statusCode);
   console.log(document);
});

Example:

Yumpu y = new Yumpu("your access token");
String[] params = { "id=27109085" };
System.out.println(y.getDocument(params));

Whatever language you are using, the result will be the same.

{
  "document": [
    {
      "id": 55919352,
      "create_date": "2016-09-08 14:02:24",
      "update_date": "2016-09-08 14:03:03",
      "url": "https://www.yumpu.com/de/document/view/55919352/new-document",
      "image": {
        "small": "https://img.yumpu.com/55919352/1/115x163/new-document.jpg"
      }
    }
  ],
  "state": "success",
  "completed_in": 0.0562
}

PreviousDocument NextPost file

Last updated 3 years ago

Was this helpful?