Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

REST Web Service Reference for Asynchronous Integration

This article provides comprehensive guidance on creating or updating an asynchronous integration using Documoto's REST API Web Services.  These APIs enable external systems to perform publisher and administrative operations, as well as retrieve and manage data stored in the Documoto Library.

Article Topics

Overview

Documoto REST API Web Services provide a RESTful interface for interacting with the Documoto platform. They allow external applications to integrate with Documoto for automation, system-to-system communication, and data management. Key features include:

  • No XML Requirement: Users are not required to use XML format
  • Flexible Data Output: Data can be outputted into various formats, including: CSV, JSON, and RSS
  • Language Compatibility: Parsed information can proceed in the programming language used your application

Getting Started

Before implementing an asynchronous integration, review the following resources:

  • Swagger Specification: Provides a complete list of available REST API endpoints, including legacy services. Use this resource for discovery and exploration, but note that not all endpoints are recommended for new implementations.

  • Documoto Headless API Documentation: Contains documentation for Documoto’s latest  “Headless” REST APIs. These APIs are the recommended option for new integrations.

Headless API coverage is still evolving and may not include complete coverage for all application features and functionality. If a required endpoint for your implementation is not available, please contact your Customer Success Manager for support.

API Web Service Requirements

Ensure the following requirements are met before making API requests:

Base URLS

Use the appropriate URL by Documoto environment to generate Web Service endpoints: 

Subdomain URLs are not supported. Always use the base URL listed above for the relevant Documoto environment.

Security and Authentication

  • HTTPS Required: All API requests must be sent over HTTPS

  • Valid API Key Required: You must have a valid API Key to send requests to the API endpoints

For information on how to create an API Key, please refer to: How to Create an API Key

Request Formatting

  • URL Encoding: Ensure the query parameters with reserved or unsafe characters are URL-encoded before use in API requests

  • Headers: Ensure required headers (such as Accept and Content Type) are properly set

Best Practices

  • Prioritize Headless APIs: For new integrations, use Headless APIs whenever possible. These endpoints are designed for modern integration use cases. 

Headless API coverage is still evolving and may not include complete coverage for all application features and functionality. If a required endpoint for your implementation is not available, please contact your Customer Success Manager for support.

  • Test in Non-Production Environments: Always test integrations in a non-Production environment (such as Integration or Sandbox) before deploying to Production.

  • Use JSON Payloads: While some services may utilize path or query parameters, multipart requests (such as file uploads or downloads) primarily use JSON formatted requests and response. 
  • Configure REST Clients Properly: When using tools such as Postman or similar REST clients:
    • Leverage the client software’s API to authorize your requests; this step will grant your API Key the appropriate permissions to access the Web Service endpoints.
    • Include required headers; for first time setups, headers for “Accept” and “Content Type” are typically required.
    • Validate request structure before sending

Support

For assistance with evaluating or utlizing Documoto’s REST API Web Services, contact your Documoto Customer Success Manager or Documoto Support at support@documoto.com.