Get
Retrieve an existing hotspot
Parameters:
Name
Optional / Required
Data type
Description
Default
id
required
String
One of your document hotspot ids
return_fields
optional
String
Customize the responses by setting the return fields (id, document_id, page, type, settings, create_date, update_date)
id, document_id, page, type, settings, create_date, update_date
Demo
URL Find your token on - yumpu.com Token
id
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/hotspot.json?id=18414788HxIRKIoB"Example:
require_once('../yumpu.php');
$yumpu = new Yumpu();
$data = array(
'id' => '18414788HxIRKIoB'
);
$listHotspot = $yumpu->getDocumentHotspot($data);
print_r($listHotspot);Example:
var yumpu = require('yumpu');
yumpu.setToken('yourToken');
var parameters = {
id: '18414788HxIRKIoB'
};
yumpu.getDocumentHotspot(parameters, function(statusCode, document){
console.log('Status: ' + statusCode);
console.log(document);
});Example:
Whatever language you are using, the result will be the same.
Last updated
Was this helpful?