Overview

The Document Cloud API provides access to a powerful and simple document conversion engine that enables users to create high quality PDFs, manipulate documents, and convert to other formats using Adobe Acrobat technology.

Discovery

Our REST API implements HATEOAS (Hypertext As The Engine Of Application State) which provides the client with complete URI's in API responses that can be used in subsequent calls. The first step in utilizing this API is calling "Discovery" which provides the available resources, methods, URI, content-type headers, accept headers, and parameters.

Discovery Response Basic Structure:

resources:
    method:
        http_method: (GET, POST, DELETE,...)
        content_type: { available versions }
        accept: { available versions }
        uri: "https://path/to/endpoint/no/hardcoding/needed"
        form_data_parameters: { description of required parameters for a form }
        authentication: ["available_authentication_methods"]

Discovery is designed to be a great source of information within your DC API app. Rather than hard coding content types and paths, simply gather the information from discovery.

assets = discovery.resources.assets
assets.export.uri               # URL to call
assets.export.http_method       # Method to use
assets.export.content_type["exportpdf_parameters_v1.json"]   # API version
assets.export.accept["new_asset_job_v1.json"]

Exporting a Document

  1. Upload your document (assets.upload).
  2. Export your document (assets.export). Export takes a file format and OCR language parameter. The complete list of available values are returned in formats.export and locales.export.
  3. Check the conversion status using the returned status URI.
  4. Download the converted document with the URI provided when the status is complete.

Development

Get all the details on the available API's with the documentation provided through this portal. Click here.

Download our SDK including samples, documentation, and getting started information through this portal. Click here.

 

On URI Template Libraries

DC API requires RFC-6570 compatible URI Templates to handle some responses. You can see examples of this in the SDK and our samples. If you are choosing your own, note the following recommended URI Template libraries; others may not be compliant to the RFC-6570 standard: