Skip to main content

Rest API Documentation

API Reference is available here: Excelifier API Documentation

Introduction​

The Excelifier API allows for automation of document conversion processes. Utilizing the API, new jobs can be programmatically initiated for document conversion.

API Key

The API requires an API key. Your API key is accessible within the api_keys section of the Excelifier portal. Read more.

Starting a New Job​

Creating a new job via the API involves sending a request that contains either a Base64 encoded file or a URL where the PDF file is available for download. Below are the necessary details for job submission:

Required Fields in Job Data:​

  • org_id: Identifier of the organization the job is associated with.
  • filename: Name of the file to be processed.
  • Either:
    • file: A string representing the Base64 encoded file data.
    • url: A string representing the URL of the file to be processed.

Optional Fields in Job Data:​

  • instructions: Any additional instructions for the job.
  • document_type: The type of document being submitted. Acceptable values include "Invoice", "SalesOrder", "PurchaseOrder", or "OrderConfirmation".
  • notify: An email address that will be notified upon job completion.
  • webhook_url: A URL that will receive a webhook notification upon job completion.
  • require_eu_processing: A boolean indicating if the job needs to be processed on EU servers.

The API validates the submitted job data and verifies user permissions for the specified organization. In cases where job data is invalid or the user lacks appropriate access, an error response is returned.

Authorizations:​

  • bearerAuth

Request Body Schema:​

  • Application/JSON with fields such as document_type, file, filename, instructions, notify, url, webhook_url.

Responses:​

The API provides detailed responses regarding the success or failure of job submissions, including error messages if applicable. Upon successful job creation, relevant details about the new job, including its unique identifier and status, are returned.