Login
Book a Demo

API Documentation

It’sRapid supports an easy-to-use API for creating PDF files with embeddable links and tables.
The documentation is below. Please contact us with any questions.

API Endpoint

  • Endpoint: https://testing.rapidads.io/api/create_hotspot_pdf
  • Method: POST

Data Structure

  • images: Array of image URLs
  • coords: Array of coordinates per image (first image corresponds to the first row of coordinates)
  • table: Array of data rows (columns are defined by the table_template_id template)
  • table_mapping_fields: Object of key-value pairs for template columns
  • template_id: (integer) ID of template for images (should contain the Background Theme Image field)
  • table_template_id: (integer) ID of template for the table (should contain an HTML field with a table)
  • output_format: Only supports pdf
  • response_type: download or link
    • download: returns the PDF output directly
    • link: returns a JSON response with a downloadable link

Example Table Data (JSON)

{
  "Name": "Insert Blank",
  "Part#": "171583",
  "Manufacturer": "Raymond",
  "UOM": "EA",
  "QTY": "2",
  "Price": "Call for price"
}

Code Sample: table_mapping_fields

"table_mapping_fields": {
  "Dynamic Product": "Raymond 102XM, 1016708 Walkie Pallet Truck Control Head"
}

Code Sample: response_type: link

{
  "success": true,
  "data": {
    "link": "https://example.com/outputs/pdf/generated_template.pdf?response-content-disposition=attachment%3B%20filename%3Dgenerated_template.pdf&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=KEY%2FDATE%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=DATE&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Signature=SECRET_SIGNATURE"
  },
  "message": "File generated successfully"
}