A
A
API
Search…
A
A
API
Yumpu documentations
JS
Introduction
Quick setup
Magazine example's
Bookshelf example's
FAQs
API
Introduction
Getting started
Limits
Flowchart of basic processes
Documents
Document
Document hotspots
Document hotspot
Get
Post
Put
Delete
Document progress
Document categories
Document languages
Countries
Collections
Collection
Section
Section document
Search
User
Embeds
Embed
Members
Member
Access tags
Access tag
Subscriptions
Subscription
Powered By
GitBook
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
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/hotspot.json?id=18414788HxIRKIoB"
Copied!
Example:
1
require_once
(
'../yumpu.php'
);
2
$yumpu
=
new
Yumpu
();
3
$data
=
array
(
4
'id'
=>
'18414788HxIRKIoB'
5
);
6
$listHotspot
=
$yumpu
->
getDocumentHotspot
(
$data
);
7
print_r
(
$listHotspot
);
Copied!
Example:
1
var
yumpu
=
require
(
'yumpu'
);
2
yumpu
.
setToken
(
'yourToken'
);
3
var
parameters
=
{
4
id
:
'18414788HxIRKIoB'
5
};
6
yumpu
.
getDocumentHotspot
(
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=18414788HxIRKIoB"
};
3
System
.
out
.
println
(
y
.
getDocumentHotspot
(
params
));
Copied!
Whatever language you are using, the result will be the same.
1
{
2
"hotspot"
:
[
3
{
4
"id"
:
"18414788HxIRKIoB"
,
5
"document_id"
:
"27109085"
,
6
"page"
:
"1"
,
7
"type"
:
"link"
,
8
"settings"
:
{
9
"x"
:
"0"
,
10
"y"
:
"0"
,
11
"w"
:
"400"
,
12
"h"
:
"100"
,
13
"name"
:
"www.yumpu.com"
,
14
"tooltip"
:
"www.yumpu.com"
,
15
"link"
:
"https://www.google.com"
16
}
,
17
"create_date"
:
"2014-09-23 07:17:39"
,
18
"update_date"
:
"2014-09-23 07:20:21"
19
}
20
]
,
21
"state"
:
"success"
,
22
"completed_in"
:
"0.1853"
23
}
Copied!
API - Previous
Document hotspot
Next
Post
Last modified
4mo ago
Copy link
Contents
Retrieve an existing hotspot
Parameters:
Demo