Get - API

Search…
Get
Retrieve the current progress of your document
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
String
One of your document progress ids
​
Demo
 URL Find your token on - yumpu.com Token 
 progress id 
Run request
1
​
Copied!
curl
PHP
JavaScript
Java
Example:
1
curl -X GET -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" "https://api.yumpu.com/2.0/document/progress.json?id=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
Copied!
Example:
1
require_once('../yumpu.php');
2
$yumpu = new Yumpu();
3
$progressId = 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX';
4
$documentProgess = $yumpu->getDocumentProgress($progressId);
5
print_r($documentProgess);
Copied!
Example:
1
var yumpu = require('yumpu');
2
yumpu.setToken('yourToken');
3
var parameters = {
4
   id: 'XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX'
5
};
6
yumpu.getdocumentProgress(parameters, function(statusCode, document){
7
   console.log('Status: ' + statusCode);
8
   console.log(document);
9
});
Copied!
Example:
1
Yumpu y = new Yumpu("your access token");
2
String[] params = {"id=XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"};
3
System.out.println(y.getDocumentProgress(params));
Copied!
Whatever language you are using, the result will be the same.
Example 1:
1
{
2
  "document": {
3
    "state": "rendering_in_progress",
4
    "message": "Magazine in rendering queue",
5
    "imagecount": "84",
6
    "progress": 0,
7
    "images": 0
8
  },
9
  "state": "success"
10
}
Copied!
Example 2:
1
{
2
  "document": [
3
    {
4
      "id": 55932706,
5
      "url": "https://www.yumpu.com/de/document/view/55932706/new-title",
6
      "short_url": "https://www.yumpu.com/s/Ok8tEcVRDCsfAod0",
7
      "image": {
8
        "small": "https://img.yumpu.com/55932706/1/115x163/new-title.jpg",
9
        "medium": "https://img.yumpu.com/55932706/1/452x640/new-title.jpg",
10
        "big": "https://img.yumpu.com/55932706/1/1129x1600/new-title.jpg"
11
      },
12
      "language": "de",
13
      "title": "new title",
14
      "description": "",
15
      "pages": 3,
16
      "width": 452,
17
      "height": 640,
18
      "category_id": 2,
19
      "tags": [
20
        "suchparameter",
21
        "liefert",
22
        "google",
23
        "webseiten",
24
        "suchbegriff",
25
        "mehreren",
26
        "angezeigt",
27
        "beschreibung",
28
        "nutzwert",
29
        "treffer",
30
        "www.lukasbals.at"
31
      ],
32
      "embed_code": "<iframe width=\"512px\" height=\"384px\" src=\"https://www.yumpu.com/de/embed/view/CsdA9tSUlmyVvbNO\" frameborder=\"0\" allowfullscreen=\"true\" allowtransparency=\"true\"></iframe>"
33
    }
34
  ],
35
  "state": "success",
36
  "completed_in": 0.0715
37
}
Copied!
API - Previous
Document progress
Next - API
Document categories
Last modified 4mo ago
Copy link
Contents
Retrieve the current progress of your document
Parameters:
Demo