Guides

RAW JSON Payload

Generate PDF files with the Raw JSON Payload through Joyfill Export API

Suggest Edits

Overview

In this guide, I'm going to show how to generate PDF using Raw JSON Payload through the Joyfill Export API

Guide

Setup Requirements

Implementation

  • Feel free to skip Steps 1 and 2 if you have a JSON Payload already.

Step 1: Retrieve identifier

You can retrieve the document or template identifier that you want to export via the Joyfill Manager (see screenshot below) or by using the Joyfill API.

Joyfill Manager Example

Joyfill Manager Example

Identifiers will be unique to your organization. Ensure you use the identifiers from your account. Do not use the ID from the screenshot above because it will not work for you.

Step 2: Retrieve the JSON Payload

Once you have the identifier you can get the JSON Payload associated with it by making a HTTP Request to the end point shown below.

a. Add URL

b. Configure Authorization

  • Type: API KEY
  • Key: Authorization
  • Value: Bearer <User_Access_Token>
  • Add to: Header

Step 3: Generate PDF

Once you have your identifier you can generate a PDF by using the Export PDF API route.

Examples

Postman

We will use Postman to send our HTTP request. However, you can use whatever tool you want to make an HTTP request to our Export API.

a. Add URL

b. Configure Authorization

  • Type: API KEY
  • Key: Authorization
  • Value: Bearer <User_Access_Token>
  • Add to: Header

c. Add Body

Important Note: You must add the JSON Payload obtained above within the document object in the body

You will get the download and preview url as the response from the Export Api Endpoint

Updated about 2 months ago