API Reference

In this section, we will understand how data mapping works in PDF Hippo

How PDF Hippo Processes Your Excel Sheet

Once a sheet is uploaded to PDF Hippo, the system processes the Excel sheet and displays the result as a PDF on the PDF viewer on the left pane

The right pane displays a list of the variable input fields. You can mention the default values in the spaces to view how the PDF is going to look - and also to map the default values in the API

Whenever one of these fields is populated, the PDF viewer reflects that value in the PDF.

📘

Tip

Do enter all the default values and see if it reflects accurately in the PDF viewer - including the alignment.

Handling Default Variables

You can pass values for the default variables. The formatting for these would have to be handled at excel. The default variables take on the same formatting as in the base excel file

Handling Table Variables

  • The tableRange mentions the header range of the table in the excel file. Any edits in the range would have to be done in excel and reuploaded
  • The valueRange mentions the range of the first row of the table in excel. Any edits in the range would have to be done in excel and reuploaded
  • Table Data can be added using a form kind of Interface - as displayed above

Handling Image Variables

  • signRange is the range over which the image is displayed. Any edits in the range would have to be done in excel and reuploaded
  • Images need to be passed as URLs

Handling EOF Variables

PDFHippo autodetects and removes the EOF variable and takes that as the end of file.

Reuploading the Template

In case post entering the values, there are certain corrections that need to be done in the base excel file, you can change the raw excel and reupload.

The default values and existing variables are saved - so you will not need to remap it again

Making the Template Live

Once you have mapped the variables and satisfied with how it looks in the editor - you are ready to publish the template to live and start generating PDFs at scale. Clicking on the publish button will generate the API for you to use