Blog Layout
I Hunted PDF Generator API on Product Hunt
Bill Doerrfeld | Jun 04, 2020
PDF Generator API is now live on Product Hunt! PDF Generator API
is a flexible Web API and template editor for PDF generation. Using PDF Generator API, you can easily embed transactional PDF document creation into your application. It's got a drag-and-drop editor that taps into end-user data to make PDFs.
I admire APIs that do one thing and do it really well, and PDF Generator API epitomizes that idea. It's a business processing utility executed well by a solid team with years of experience focusing on a single idea: automating the PDF documentation generation process.
Review of PDF Generator API
What's The Use Case?
Many document-heavy business applications, like an eCommerce shop, accounting firm, or an ERP platform, need to generate PDFs for things like invoices, packing slips, contracts, and labels. The issue is that manual PDF creation is pretty tedious. So, a lot of these scenarios will create reusable templates. PDF Generator API is automating this process, helping avoid development duplication, and aiding in custom template creation.
Designing Templates
PDF Generator API offers an embeddable drag-and-drop editor so that end-users can design their own custom templates. Users choose how their data will be shown, within Text, Tables, Containers, and other fields, or you can generate standard Images and Footers to include in all your PDFs. Once you create a template, you merge them with your data by using the REST API to generate PDFs. You can upload a JSON file to try out using the editor without an integration.
Quality Developer Experience (DX) ✔️
When it comes to DX, PDF Generator API is following all the best practices. Onboarding is straightforward; simply sign up to instantly obtain an API key. Powered by
Redoc, PDF Generator API boasts beautiful 3-columned API documentation
that is really easy to navigate. Docs are auto-generated from a OpenAPI v3.0
spec. That's awesome, since using OpenAPI provides other abilities; they've added a Run in Postman
button so you can test out API calls lickety-split. It's a RESTful API, so it's pretty easy to follow.
Developer Resources
PDF Generator API excels at appeasing many use cases. Docs come handy with copy and pastable code samples in PHP, Python, Java, Ruby, and other languages & frameworks. You can also view JSON responses and error messages for any function.
Accounts & Pricing
PDF Generator API offers a pretty generous free account, allowing up to 500 merges per month. Beyond that, you can check out their pricing
plans.
Sample Invoice Creation Using PDF Generator API: eCommerce SaaS
To see how PDF Generator API works in action, let's consider how a business would use it to streamline PDF creation. Say our company is a document-heavy business, like an eCommerce SaaS. The eCommerce SaaS enables users to send invoices to end customers on a monthly basis.
Our users require custom designs for PDF invoices to match their storefront branding and to display up-to-date information. However, fulfilling their needs through development cycle is expensive. The eCommerce SaaS wants to avoid extra costs from developers and support so that the customer themselves can build their templates.
The goal is to create a reusable, automated process to generate PDFs on a large scale, while allowing for customization. First, we design a PDF template using drag-and-drop widgets. These include text fields, columns, images, QR codes, and more. We can customize color and fonts to match our company brand. You can view an active demo template
here.
Next, we insert data fields by choosing which property to display and where. For example, one text box uses the {invoice_date} field to display the date. {invoice_number}
is used to insert the invoice number. Multiple fields can be inserted in the same text box. Such as the following company information:
{company}
{address1}
{city}
You can even write in expressions to accumulate sums. In this case, the expression ${% sum({line_items::total_cost}) %}
calculates the total cost of good and services. Once the template is finished, to create a PDF we must merge the template with an API request that sends JSON formatted with the identical field names. We make an API request to the base URL endpoint
https://us1.pdfgeneratorapi.com/api/v3
with our API key.
To demonstrate, here is some sample JSON which would be sent with the API request:
{ "invoice_number": "4698018857", "phone_number": "(978) 555-7555", "email_id": "johnmiller@pdfgeneratorapi.com", "name": "John Miller", "logo": "https://www.onlinelogomaker.com/images/tutorialnew/tutorial.jpg", "customer_memo": "Thank you for your business and have a great day!", "period": "July period", "invoice_date": "2019-08-03", "address1": "2 Maple St", "phone": null, "city": "New Milford", "zip": "18834-2014", "province": "Pennsylvania", "country": "United States", "last_name": "LeBron", "address2": null, "company": "ACME Company Inc", "credit": { "balance": 0.0 }, "line_items": [ { "total_cost": 182, "hours": 7, "fee": 12, "description": "DB Architecture", "note": "Database architecture focuses on the design, development and implementation." }, { "total_cost": 189, "hours": 9, "fee": 29, "description": "Analysis", "note": "Detailed examination of anything complex in order to understand its nature or to determine its essential features" }, { "total_cost": 175, "hours": 5, "fee": 15, "description": "Web scrapping", "note": "Web scraping, web harvesting, or web data extraction is data scraping used for extracting data from websites" }, { "total_cost": 160, "hours": 8, "fee": 10, "description": "Web design", "note": "Responsible for creating the design and layout of a website or web pages" } ] }
On the client-side, you could export a PDF from the editor. Though, since it's API-driven, the exact process is super flexible. You could create a form to input this data, or hook into your CRM systems. The end result is a slick PDF to send to our client! PDF Generator API can also generate an HTML version to reduce file size and bloat. You can view a sample HTML version here.
I'm getting excited for this year's Platform Summit , to be held October 7-9 2024. Speaker submissions are now open! For those unaware, the Platform Summit is Nordic APIs' flagship API conference. Every year, we collect some of the brightest minds in the API industry for an intimate summit to discuss how to create top-tier API platforms. The event is now in its 7th year. I'm helping review submissions for the event and we've already got some great submissions. But, we'd love to feature more API case studies and welcome newcomers. Talk submission details are here . I'm also happy to chat if anyone would like to learn more or suggest topic ideas. Feel free to reach out on my contact page . Here's a playlist of sessions from Platform Summit 2023:
There are a lot of challenges in open source right now. From new licensing restrictions, supply chain issues, open source contributor equity, and beyond, there's a lot to consider. I've gathered input from some of the leading thought leaders in the open-source ecosystem to explore the top challenges facing open source and what the industry needs to evolve. Right now, I'm just looking for the right home for this article. I'm really excited to get this one published!
My opening keynote from the Austin API Summit 2024 explores the similarities between producing hit albums and hit APIs. It's now published here on YouTube . As it turns out, making a hit API is a lot like making a hit music album. You have to find a niche, you need good naming, and you need quality content. Also, on the production side, design, style, experience, and collaboration all matter a lot. At the end of the day, both are products, requiring the right management tools, marketing know-how, and infrastructure to scale. In this SXSW-inspired opening keynote, I look into the parallels between the two endeavors, providing a fun and informative look into specific things API providers should be considering on their journey toward becoming API platform rockstars.
How is AI evolving API management?
Calling all CIOs...
My opening keynote from the Platform Summit 2023 looks at the role APIs play in shaping our daily lives. It's now published on YouTube. APIs are increasingly in the public consciousness. In this keynote, I examine the role web APIs continue to play in the lives of both end users and software developers. From social media to generative AI, I briefly explore ome areas where APIs currently have the most impact. Whether you are a high-level architect or ground-floor engineer, this talk should provide helpful takeaways and inspire you to keep chugging along with your API-first platform designs.
Today I am thrilled to announce a major milestone update — v30.0! New features include: baby, house, dad responsibilities. This release is backward compatible with v2X.X but 1X.X is no longer supported.
I recently made an appearance on Kin Lane's new show, API Storytelling, a regular discussion about storytelling in the world of Application Programming Interfaces (APIs). You can watch our talk here . It's not often that my musings on the tech industry directly intersect with my Creative Writing major past, so this was really fun to be a part of. The event also helped me realize how much I rely on basic storytelling techniques on a daily basis as a tech journalist and editor. I don't consider blogging about why GraphQL has usurped REST a creative writing endeavor per se, but much of what I do involves fundamental storytelling techniques. For example, most of my articles use a three-part structure involving a nut graf (introduction), a problem statement, and a resolution. I prefer thesis-driven posts that have a good framework, similar to what Brian McDonald calls an "armature." Good stories entertain, but great ones carry lessons. Stories impart survival techniques. From the perspective of a tech business publication, the best practices and case studies you share could result in success, whereas those without a lifeline to stories could suffer disruption. Storytelling is critical to share knowledge and improve an industry, especially within a domain with such intense evolution as tech.
I was recently interviewed by Coding over Cocktails on my journey covering the API economy in the past 6 years. Check out the podcast on Spotify.
A review of some simple projects I made that use open geo APIs to power simple websites to return quick celestial data.
