This FAQ is designed to answer your questions about our API and help you get started using it effectively. Whether you're a seasoned developer or just beginning your journey with our API, we're here to provide you with the information you need.
Here, you'll find answers to common questions:
FAQs
-
Is it possible to directly embed through the API on a website or do you need to IFrame it?
- Yes, it is possible to embed directly. It does exactly the same as the product.
- Yes, it is possible to embed directly. It does exactly the same as the product.
-
Could we use the API to post a file to Issuu to get a unique URL to use for displaying on our internal website? Or is the API mainly used for data transmission?
- Yes, right now only for drafts and publications.
- Yes, right now only for drafts and publications.
-
Can we sort out the document list by oldest to newest (and vice-versa)?
- Only by getting everything and sorting it.
- Only by getting everything and sorting it.
-
Can we download the original PDFs through the API?
- No.
- No.
-
Is there a way to retrieve contents in stack sequence by default when using the API call with a specified folderId in Issuu's API?
- Yes. The endpoint below will help you retrieve the necessary stack information for each publication. In this case, you will be using stackID instead.
https://api.issuu.com/v2/reference/#get-/stacks/-stackId-
- Yes. The endpoint below will help you retrieve the necessary stack information for each publication. In this case, you will be using stackID instead.
-
How can I remove the "Powered by Issuu" when uploading and getting the embed via API call?
- If you have this feature you have a flag in the endpoint that allows you to remove the "Powered by Issuu" bar.
- If you have this feature you have a flag in the endpoint that allows you to remove the "Powered by Issuu" bar.
-
Is there a sandbox environment for testing Issuu's API?
- No.
- No.
-
What security measures are recommended when integrating Issuu's API into a production environment?
- Keep your token secure (do not share it).
- Keep your token secure (do not share it).
-
Can I integrate Issuu's API with third-party analytic tools for more detailed insights?
- Yes, but this has to be developed by the user.
- Yes, but this has to be developed by the user.
-
Are there any restrictions when using Issuu's API in a mobile application?
- No.
- No.
-
Is it possible to embed interactive elements within publications using the API?
- It does exactly the same as the product version.
- It does exactly the same as the product version.
-
Can I retrieve detailed user engagement data, such as time spent on each page, through the API?
- Yes, but for now only for publications (all or selected).
- Yes, but for now only for publications (all or selected).
-
How can I ensure the secure transmission of sensitive data, such as document content, between my application and Issuu's servers?
- All endpoints are served through HTTPS forcing end-to-end encryption of data.
- All endpoints are served through HTTPS forcing end-to-end encryption of data.
-
Can I automate the extraction of text content from publications using the API, for purposes such as translation?
- Yes, we have the
/publications/{slug}/assets
that if the text is selected as asseType can return the publication's text.
- Yes, we have the
-
How does Issuu's API handle versioning for publications, can I programmatically roll back to a previous version?
- Currently, no.
- Currently, no.
-
Does Issuu's API handle large files?
- There is a limit but it depends on the internet connection.
- There is a limit but it depends on the internet connection.
-
How can I implement a content archive using the API to store versions of publications or track changes over time?
- Currently, it is not possible.
If you don't find the answer you're looking for, feel free to reach out. Check here how to contact our support team.
Comments
0 comments
Article is closed for comments.