Skip to main content

PDF

Get PDF Magazine

The "Get PDF Magazine" API allows users to retrieve a webpage that includes a PDF document by slug.

  • Endpoint: api/customer/pdf/{slug}

  • HTTP Method: GET

  • URL Parameters:

    • slug (required): The slug of the PDF.
  • Success Response:

KeyTypeDescription
idintegerThe unique identifier of the PDF.
slugstringThe slug of the PDF.
pathstringThe path of the PDF.
urlstringThe url of the PDF.
{
"code": 200,
"message": "Success",
"data": {
"id": 1,
"slug": "doc",
"path": "https://doc.supercommerce.io/",
"url": "https://docapi.supercommerce.io/api/customer/pdf/viewer?file=https%3A%2F%2Fdoc.supercommerce.io%2F"
},
"meta": []
}
info

Check the following section to learn more about the Show PDF By Slug API Reference

Show PDF Magazine

The "Get Page with PDF" API allows users to retrieve a webpage that includes a PDF document. This feature is designed for integrating PDF content seamlessly into websites through an iframe or other embedding methods. By using this API, you can fetch webpages with embedded PDFs and display them within your website, enhancing the user experience.

  • Endpoint: api/customer/pdf/viewer

  • HTTP Method: GET

  • Query Parameters:

    • file (required): The Url of the PDF.
  • Success Response:

the API response to be a webpage that can be shown within an iframe, This HTML response can be directly embedded within an iframe on a web page to display the content of the PDF retrieved from the API.

info

Check the following section to learn more about the PDF Viewer Iframe API Reference