Comment on page
Post
Name | Optional / Required | Data type | Description | Default |
document_id | required | Integer | One of your document ids | |
page | required | String | Page number (1-X) | |
type | required | String | Type can be link, video, audio or slideshow | |
settings[x] | required | Integer | x position of the document hotspot | |
settings[y] | required | Integer | y position of the document hotspot | |
settings[w] | required | Integer | width of the document hotspot | |
settings[h] | required | Integer | height of the document hotspot | |
settings[name] | required | String | a name for the document hotspot (min. length 5, max. length 50) | |
settings[tooltip] | required | String | a tooltip for the document hotspot (min. length 5, max. length 50) | |
settings[link] | optional | String | a url (valid URL) | |
settings[source] | optional | String | youtube, vimeo, flickr, soundcloud, yumpu | |
settings[source_id] | optional | String | youtube: a valid youtube video id vimeo: a valid vimeo video id flickr: a valid flickr id | |
settings[source_ids] | optional | String | One or multiple media ids separated by a comma (example: GlKIWjJyWtg2XFKi,tFtOzlqZyqeaNkfw) | |
settings[source_url] | optional | String | soundcloud: a valid soundcloud url | |
settings[autoplay] | optional | String | y or n | |
settings[show_arrows] | optional | String | y or n | |
settings[show_headline] | optional | String | y or n | |
settings[object_fit] | optional | String | y or n | |
settings[background_opacity] | optional | String | 0 to 1 | |
settings[background_color] | optional | String | Hexadecimal value, 6 characters. 000000 - FFFFFF | |
settings[hideborder] | optional | String | y or n | |
settings[asarea] | optional | String | y or n | |
document_id page type settings[x] settings[y] settings[w] settings[h] settings[name] settings[tooltip]
settings[link] settings[source] settings[source_id] settings[source_ids] settings[source_url] settings[autoplay]
Add optional parametersRun request
curl
PHP
JavaScript
Java
Example:
curl -X POST -H "X-ACCESS-TOKEN: YOUR_ACCESS_TOKEN" -d "document_id=27109085" -d "page=4" -d "type=link" -d "settings[x]=100" -d "settings[y]=100" -d "settings[w]=50" -d "settings[h]=50" -d "settings[name]=google.com" -d "settings[tooltip]=google.com" -d "settings[link]=https://www.google.com" "https://api.yumpu.com/2.0/document/hotspot.json"
Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'document_id' => '55919352',
'page' => '1',
'type' => 'link',
'settings' => array(
'x' => 100,
'y' => 100,
'w' => 20,
'h' => 20,
'name' => 'google.com',
'tooltip' => 'google.com',
'link' => 'https://www.yumpu.com'
)
);
$hotspot = $yumpu->postDocumentHotspot($data);
print_r($hotspot);
Example:
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
document_id: 27109085,
page: 4,
type: 'link',
settings: {
x: 100,
y: 100,
w: 50,
h: 50,
name: 'google.com',
tooltip: 'google.com',
link: 'https://www.yumpu.com'
}
};
yumpu.postDocumentHotspot(parameters, function(statusCode, document){
console.log('Status: ' + statusCode);
console.log(document);
});
Example:
Yumpu y = new Yumpu("your access token");
String[] params = {"document_id=27109085", "type=link", "page=4"};
String[] settings = {"x=100", "y=100", "w=50", "h=50", "name=google.com", "tooltip=google.com", "link=https://www.yumpu.com"};
System.out.println(y.postDocumentHotspot(params, settings));
Whatever language you are using, the result will be the same.
{
"hotspot": [
{
"id": "5c905d027BHYFhLg",
"document_id": "27109085",
"page": "4",
"type": "link",
"settings": {
"x": "100",
"y": "100",
"w": "50",
"h": "50",
"name": "google.com",
"tooltip": "google.com",
"link": "https://www.yumpu.com"
},
"create_date": "2014-09-23 08:18:53",
"update_date": "0000-00-00 00:00:00"
}
],
"state": "success",
"completed_in": "0.1644"
}
Last modified 1yr ago