api2pdf 0.0.10

Wrapper for api2pdf.com library for converting html, urls, and word documents to pdf

api2pdf.python

Python bindings for Api2Pdf REST API

Api2Pdf.com is a REST API for instantly generating PDF documents from HTML, URLs, Microsoft Office Documents (Word, Excel, PPT), and images. The API also supports merge / concatenation of two or more PDFs. Api2Pdf is a wrapper for popular libraries such as wkhtmltopdf, Headless Chrome, and LibreOffice.

• Installation
• Resources
• Authorization
• Usage
• FAQ

Add a dependency

PyPI

Run the pip command for installing the client pip install api2pdf

Resources

Resources this API supports:

• wkhtmltopdf
• Headless Chrome
• LibreOffice
• Merge / Concatenate PDFs
• Helper Methods

Authorization

Acquire API Key

1. Create an account and login at portal.api2pdf.com
2. Add a balance to your account (no monthly commitment, sign up with as little as $1)
3. Create an application and grab your API Key

Usage

Initialize the Client

All usage starts by calling the import command and initializing the client by passing your API key as a parameter to the constructor.

from api2pdf import Api2Pdf

a2p_client = Api2Pdf('YOUR-API-KEY')

Once you initialize the client, you can make calls like so:

api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>')
print(api_response.result)

Result Object

An Api2PdfResponse object is returned from every API call. Call the result attribute to retrieve the data. If a call is unsuccessful then success will show False and the error will provide the reason for failure. Additional attributes include the total data usage in, out, and the cost for the API call, typically very small fractions of a penny.

{
    'pdf': 'https://link-to-pdf-only-available-for-24-hours',
    'mbIn': 0.08421039581298828,
    'mbOut': 0.08830547332763672,
    'cost': 0.00017251586914062501,
    'success': True,
    'error': None,
    'responseId': '6e46637a-650d-46d5-af0b-3d7831baccbb'
}

For debugging, you can print the Api2PdfResponse object to see the request and response data.

api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>')
print(api_response)

Output:

---- API2PDF REQUEST ----
- Headers: {'Authorization': 'YOUR-API-KEY'}
- Endpoint: https://v2018.api2pdf.com/chrome/html
- Payload:
{'html': '<p>Hello, World</p>'}
---- API2PDF RESPONSE ----
{'pdf': 'https://link-to-pdf-only-available-for-24-hours', 'mbIn': 0.08421039581298828, 'mbOut': 0.08830547332763672, 'cost': 0.00017251586914062501, 'success': True, 'error': None, 'responseId': '163c4d25-25d7-4b82-bf50-907597d2ad46'}

wkhtmltopdf

Convert HTML to PDF

api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>')

Convert HTML to PDF (load PDF in browser window and specify a file name)

api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf')

Convert HTML to PDF (use keyword arguments for advanced wkhtmltopdf settings) View full list of wkhtmltopdf options available.

options = {
    'orientation': 'landscape',
    'pageSize': 'A4'
}
api_response = a2p_client.WkHtmlToPdf.convert_from_html('<p>Hello, World</p>', **options)

Convert URL to PDF

api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com')

Convert URL to PDF (load PDF in browser window and specify a file name)

api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf')

Convert URL to PDF (use keyword arguments for advanced wkhtmltopdf settings) View full list of wkhtmltopdf options available.

options = {
    'orientation': 'landscape',
    'pageSize': 'A4'
}
api_response = a2p_client.WkHtmlToPdf.convert_from_url('http://www.api2pdf.com', **options)

---

Headless Chrome

Convert HTML to PDF

api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>')

Convert HTML to PDF (load PDF in browser window and specify a file name)

api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', inline_pdf=True, file_name='test.pdf')

Convert HTML to PDF (use keyword arguments for advanced Headless Chrome settings) View full list of Headless Chrome options available.

options = {
    'landscape': True
}
api_response = a2p_client.HeadlessChrome.convert_from_html('<p>Hello, World</p>', **options)

Convert URL to PDF

api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com')

Convert URL to PDF (load PDF in browser window and specify a file name)

api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', inline_pdf=True, file_name='test.pdf')

Convert URL to PDF (use keyword arguments for advanced Headless Chrome settings) View full list of Headless Chrome options available.

options = {
    'landscape': True
}
api_response = a2p_client.HeadlessChrome.convert_from_url('http://www.api2pdf.com', **options)

---

LibreOffice

LibreOffice supports the conversion to PDF from the following file formats:

• doc, docx, xls, xlsx, ppt, pptx, gif, jpg, png, bmp, rtf, txt, html

You must provide a url to the file. Our engine will consume the file at that URL and convert it to the PDF.

Convert Microsoft Office Document or Image to PDF

api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx')

Convert Microsoft Office Document or Image to PDF (load PDF in browser window and specify a file name)

api_response = a2p_client.LibreOffice.convert_from_url('https://www.api2pdf.com/wp-content/themes/api2pdf/assets/samples/sample-word-doc.docx', inline_pdf=True, file_name='test.pdf')

---

Merge / Concatenate Two or More PDFs

To use the merge endpoint, supply a list of urls to existing PDFs. The engine will consume all of the PDFs and merge them into a single PDF, in the order in which they were provided in the list.

Merge PDFs from list of URLs to existing PDFs

links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF']
merge_result = a2p_client.merge(links_to_pdfs)

Merge PDFs from list of URLs to existing PDFs (load PDF in browser window and specify a file name)

links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF']
merge_result = a2p_client.merge(links_to_pdfs, inline_pdf=True, file_name='test.pdf')

---

Helper Methods

Api2PdfResponse: download_pdf()

On any Api2PdfResponse that succesfully generated a pdf, you can use the handy download_pdf() method to download the pdf to a file-like object which you can then save to your local cache. If the pdf generation was unsuccessful, it will throw a FileNotFoundException.

from api2pdf import Api2Pdf
a2p_client = Api2Pdf('YOUR-API-KEY')

# merge pdfs
links_to_pdfs = ['https://LINK-TO-PDF', 'https://LINK-TO-PDF']
merge_result = a2p_client.merge(links_to_pdfs)

pdf_as_file_object = merge_result.download_pdf()

---

FAQ

How do you bill?

$1 will be deducted from your balance every month as long as you maintain an active account. This charge begins 30 days after your first sign up for the service. In addition, we charge $0.001 per megabyte (data in + data out). We require customers to maintain a positive balance on their account to use the service. You can turn off auto-recharge at any time and let your funds run out if you no longer wish to use the service. See our pricing calculator.

Do you offer free accounts?

The average customer spents about $2/month on our product. We do not have free accounts as this time. Feel free to check out alternatives and competitors.

Cancellation and refunds

We do not have any long term contracts. You can leave us at anytime with no further commitments. As our minimum cost is $1.00, we do not provide refunds.

Are there any limits?

Api2Pdf does not set any specific limits on PDF file size, however our system does have processing power limitations. Each PDF request is provided 3 GB of RAM to work with and 90 seconds to generate the PDF. We offer WKHTMLTOPDF, Headless Chrome, and LibreOffice to do conversions. Our platform will have the same limits as those underlying components. If the underlying component fails to convert to PDF, it will also fail via our service. Some examples are:

• Password protected PDFs
• Encrypted PDFs
• HTML that references erroneous content
• Protected Office Documents

How long are PDFs stored on Api2Pdf.com?

After generating a PDF via the API, you are provided with a link to the file. This link will hold the PDF for 24 hours. If you wish to keep your PDF long term, download the file to your local cache.