Api

REST API Overview

The Eledo REST API allows you to work with templates, generate PDF documents, and retrieve supporting metadata.

All endpoints are available under:

https://eledo.online/api/RESTv1/

Authentication

Eledo uses HTTP header authentication with an API Key.

Authentication details are described in the Authentication section.


Document Generation

There are two main ways to generate documents:

1. Synchronous generation (most common)

Use this approach when you need an immediate response:

  1. List Get a list of your templates and find out a template ID for further API calls

  2. Schema Retrieve JSON schema for a specific template and organize your data into a JSON payload for generation endpoint

  3. Generate Generate your document and get it as a response


2. Asynchronous generation (advanced)

Use this approach when processing larger workloads or when immediate response is not required:

  1. Create File Store your JSON data as a File and get a download URL

  2. Download Generate and download your document with File ID included in download URL

Identification

When working with multiple API Keys it's good to know which account they are for.


Was this article helpful?

Yes

No