DocSpring API Connector - Ismena website

info@ismena.com

DocSpring API Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The DocSpring API Connector facilitates seamless integration with the DocSpring service, providing access to PDF generation, template management, submission processing, and document handling capabilities. This connector acts as a proxy to streamline PDF operations, supporting actions for template creation, PDF generation, batch processing, and document management.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the DocSpring API Connector.
Supported Integration Action Points

Authentication: Test API authentication and verify credentials
Template Management: Create, read, update, delete, and manage PDF/HTML templates
PDF Generation: Generate individual PDFs from templates
Batch Processing: Process multiple PDF submissions in batches
Submission Management: Check status, expire, and manage PDF submissions
Combined PDFs: Merge multiple PDFs into single documents
Folder Management: Organize templates in folder structures
Custom Files: Upload and manage custom files for PDF operations
Data Requests: Handle form data collection and processing

Detailed Integration Documentation

Authentication Testing

Action	GET /authentication
Purpose	Validates API credentials and tests connectivity to the DocSpring service.
Configuration	Ensure the connector is configured with the appropriate environment variables.
Parameters	Required: Authorization: Basic authentication token (string, e.g., Basic YXBpX3Rlc3RfRkZY...) Optional: None
Output	Successful: Returns a JSON object with: status: Authentication status (string, e.g., "success") Failure: Returns error details (e.g., {"error": "Unauthorized"})
Workflow Example	Execute the authentication endpoint with valid Authorization header. Verify the response status is "success". Proceed with API operations if authentication is valid.

Template Management

Endpoints	GET /templates - List all templates POST /templates - Create new template GET /templates/{template_id} - Get template details PUT /templates/{template_id} - Update template DELETE /templates/{template_id} - Delete template
Purpose	Manage PDF and HTML templates for document generation.
Parameters	Required for creation: Authorization: Basic authentication token Template configuration (name, type, content) Optional: parent_folder_id: Folder for organization description: Template description Various template settings
Output	Successful: Returns template object with: id: Template identifier name: Template name template_type: PDF or HTML document_state: Processing status Various configuration properties Failure: Returns error details with status code and message.
Workflow Example	Create a template using POST /templates. Retrieve template schema using GET /templates/{id}/schema. Use template ID for PDF generation operations.

Single PDF Generation

Action	POST /templates/{template_id}/submissions
Purpose	Generate a single PDF from a template with provided data.
Parameters	Required: Authorization: Basic authentication token template_id: Target template identifier JSON data for template filling Optional: None
Output	Successful: Returns submission object with: status: Generation status submission: Submission details including ID and state Processing metadata and download URLs when ready Failure: Returns error details with status code and message.
Workflow Example	Prepare JSON data matching template schema. Submit generation request to template submissions endpoint. Monitor submission status until processed. Retrieve generated PDF using download URLs.

Batch PDF Processing

Endpoints	POST /submissions/batches - Create batch submission GET /submissions/batches/{batch_id} - Check batch status
Purpose	Process multiple PDF generations in a single batch operation.
Parameters	Required: Authorization: Basic authentication token Array of submission data objects
Output	Successful: Returns batch object with: submission_batch: Batch metadata and status submissions: Array of individual submission statuses Progress tracking (completion_percentage, error_count)
Workflow Example	Prepare array of submission data for batch processing. Submit batch creation request. Monitor batch status using batch ID. Retrieve individual PDFs as they complete processing.

Submission Status Management

Endpoints	GET /submissions/{submission_id} - Check submission status DELETE /submissions/{submission_id} - Expire submission GET /submissions - List all submissions
Purpose	Monitor and manage PDF submission lifecycle.
Parameters	Required: Authorization: Basic authentication token submission_id: Target submission identifier
Output	Successful: Returns detailed submission object with: Processing state and timestamps Download URLs and PDF metadata Data validation errors if any
Workflow Example	Generate PDF submission and obtain submission ID. Poll status endpoint until state changes to "processed". Retrieve permanent download URL for generated PDF. Optionally expire submission when no longer needed.

PDF Combination Service

Endpoints	POST /combined_submissions - Merge multiple PDFs GET /combined_submissions/{combined_id} - Check combination status DELETE /combined_submissions/{combined_id} - Expire combined PDF
Purpose	Combine multiple PDF documents into a single file.
Parameters	Required: Authorization: Basic authentication token source_pdfs: Array of PDF sources (submissions, templates, URLs)
Output	Successful: Returns combined submission object with: Combined PDF metadata and status Download URL for merged document Source document references
Workflow Example	Identify PDF sources to combine (submissions, templates, URLs). Submit combination request with source array. Monitor processing status. Download merged PDF document.

Workflow Creation with the Connector

Example Workflow: Document Generation Pipeline

DocSpring Workflow Overview

Template Setup	Use POST /templates to create or upload PDF template. Retrieve template schema using GET /templates/{id}/schema. Validate data structure against template requirements.
Single Document Generation	Execute POST /templates/{id}/submissions with JSON data. Monitor submission status using GET /submissions/{id}. Download generated PDF when processing completes.
Batch Processing	Prepare multiple data payloads for batch processing. Submit batch using POST /submissions/batches. Track progress with GET /submissions/batches/{batch_id}. Retrieve individual PDFs as they become available.
Document Management	Organize templates using folder endpoints. Combine related PDFs using combination service. Manage submission lifecycle (expire when needed).

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking