Get

Retrieve an existing embed

Parameters:

Name

Optional / Required

Data type

Description

Default

required

String

One of your embed ids

return_fields

optional

String

Customize the responses by setting the return fields ('id', 'user_id', 'document_id', 'type', 'create_date', 'code', 'settings')

'id', 'user_id', 'document_id', 'type', 'create_date', 'code', 'settings'

Demo

URL Find your token on - yumpu.com 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/embed.json?id=zKtHE23d6R0qT1rf"

Example:

require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
    'id' => 'zKtHE23d6R0qT1rf',
);
$listEmbed = $yumpu->getEmbed($data);
print_r($listEmbed);

Example:

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

Example:

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

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

{
  "embed": {
    "id": "zKtHE23d6R0qT1rf",
    "user_id": 10000,
    "document_id": "11199",
    "type": "4",
    "create_date": "2014-12-03 10:57:49",
    "code": "iframe",
    "settings": {
      "background_color": 253139,
      "destination": "https://www.yumpu.com",
      "download_pdf_enabled": 1,
      "height": "100",
      "start_page": 1,
      "text_font_color": "0082b2",
      "text_font_family": "ABeeZee:regular:latin",
      "text_font_size": 14,
      "text_font_style": "off",
      "text_font_weight": "off",
      "width": "100"
    }
  },
  "state": "success",
  "completed_in": "0.0665"
}

PreviousEmbed NextPost

Last updated 3 years ago

Was this helpful?