DocRaptor
Last updated October 02, 2020
Table of Contents
The DocRaptor add-on converts HTML into PDF and XLS documents on the fly from your application using DocRaptor’s HTML to PDF cloud API.
DocRaptor has libraries for PHP, Python, Node.js, Ruby, Java, .NET, and JavaScript/jQuery, though any language can be used by directly implementing the HTTP API.
Add-on provisioning
DocRaptor can be attached to a Heroku application via the add-on page or via the CLI:
$ heroku addons:create docraptor
Creating docraptor on ⬢ sharp-mountain-4005... free
Created docraptor-pointy-98065 as DOCRAPTOR_API_KEY, DOCRAPTOR_URL
Use heroku addons:docs docraptor to view documentation
A list of all plans available can be found here or by running heroku addons:plans docraptor
Application integration
You can get your DocRaptor API key through the CLI:
$ heroku config:get DOCRAPTOR_API_KEY
YOUR_API_KEY_HERE
Then visit the DocRaptor documentation site to get libraries, example code, and API options for PHP, Python, Node.js, Ruby, Java, .NET, and JavaScript/jQuery. Any other language can be easily integrated directly through the REST API.
Document styling and API options
DocRaptor’s documentation site contains detailed style and formatting guides as well as a full API reference. If you’re familiar with traditional open-source HTML to PDF libraries, you may be surprised by DocRaptor’s support for advanced document features, such as page break control, varying sizes and layouts, headers and footers, and accessible PDFs. h
Debugging
Both successful and failed document requests are available within your DocRaptor dashboard. The dashboard by visiting the Heroku Dashboard and selecting the application in question, then select DocRaptor from the Add-ons menu. Alternatively, you can open the dashboard via the CLI:
$ heroku addons:open docraptor
Opening https://addons-sso.heroku.com/apps/your_app_id/addons/your_addon_id...
Most issues can be easily debugged by looking at the document error logs or by reviewing style and formatting guides. For additional assistance, contact DocRaptor support at support@docraptor.com. We’d be happy to assist you in getting the perfect document.
Migrating between plans
Use the heroku addons:upgrade CLI command to migrate to a new plan by upgrading (or downgrading):
$ heroku addons:upgrade docraptor:premium
Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:starter to docraptor:basic... done, $19/month
$ heroku addons:downgrade docraptor:starter
Changing docraptor-pointy-98065 on sharp-mountain-4005 from docraptor:basic to docraptor:starter... done, free
Canceling DocRaptor
You can cancel your DocRaptor plan by destroying the Heroku provisioning:
$ heroku addons:destroy docraptor
▸ WARNING: Destructive Action
▸ This command will affect the app sharp-mountain-4005
▸ To proceed, type sharp-mountain-4005 or re-run this command with --confirm sharp-mountain-4005
> sharp-mountain-4005
Destroying docraptor-pointy-98065 on ⬢ sharp-mountain-4005... done
Support
Billing and Heroku account issues should be submitted via one of the Heroku Support channels. All technical questions and product feedback is welcome by contacting us at support@docraptor.com. We are happy to assist with debugging your documents.