Create a document embed that can be hosted on your own web site.
Action: issuu.document_embed.add
This method requires authentication.
Name | Data type | Description |
---|---|---|
apiKey (required) | string | Application key for the account |
signature (required) | string | See Signing Requests |
documentId (required) | string | The document that will be shown by the embed widget. The documentId is returned when you upload a document See issuu.document.upload or by listing See issuu.documents.list |
readerStartPage (required) | integer | The page in the document that the widget should initially display |
width (required) | integer | The width in pixels of the embed widget |
height (required) | integer | The height in pixels of the embed widget |
format | enum | Must be "xml" or "json" - default is "xml". See Getting Started for further details |
jsonCallback | string | Function wrapper for JSONP requests. See Getting Started for further details |
Here is a basic example of an HTML form.
<form action="http://api.issuu.com/1_0" method="get">
<input type="hidden" name="action" value="issuu.document_embed.add"/>
<input type="hidden" name="apiKey" value="g0ch5rj9ywztlo022w70naymutm2fbbg"/>
<input type="text" name="documentId"/>
<input type="text" name="readerStartPage"/>
<input type="text" name="width"/>
<input type="text" name="height"/>
<input type="submit" value="Create embed"/>
</form>
Name | Data type | Description |
---|---|---|
id | integer | Unique identifier of the embed |
dataConfigId | string Identifier used by the embed widget | |
documentId | string | Document displayed in embed widget |
readerStartPage | integer | Page initially shown in widget |
width | integer | Pixel width of embed widget |
hight | integer | Pixel height of embed widget |
created | date | Timestamp for when embed was created |
XML
<rsp stat="ok">
<documentEmbed id="1000071" dataConfigId="1000980/1000071" documentId="131030112546-6d0a51367a23473ea2ee048000732333" readerStartPage="3" width="320" height="240" created="2013-10-30T11:25:47.000Z"/>
</rsp>
JSON
{
"rsp": {
"_content": {
"documentEmbed": {
"id": 1000068,
"dataConfigId": "1000974/1000068",
"documentId": "131030110954-12df4c6d21ba49af8eb1350219b0d4ef",
"readerStartPage": 3,
"width": 320,
"height": 240,
"created": "2013-10-30T11:09:55.000Z"
}
},
"stat": "ok"
}
}
Code | Message |
---|---|
009 | Authentication required |
010 | Invalid API key |
200 | Required field is missing |
201 | Invalid field format |