Getting Started

Well, we know we said 1-2-3, but we still need to make sure it’s you.

To get started, you need to create an account on our Developer Portal. Look for the Sign Up button, enter your information and click Continue followed by Create Account buttons.

At this point you will receive an email that will prompt you to verify your email address. Click the VERIFY MY ACCOUNT button to confirm your email address.

Obtain a license key by selecting the Resources tab and navigating to the Manage License Keys section.

Click the Create Key button to visualize the services we offer. These will be displayed under the Permissions – PDF API section. Before creating a key contact our Sales Department to enable your account with the features you need.

Fill out your information, in the Product of Interest drop-down select API Service and in the What solution will you like to build information field - specify the features you are interested in (i.e. Merge, Compress etc.) and click Submit.

You will receive a confirmation email stating that your Avanquest Dev Portal account has been verified and activated.

Select the type of license Permissions within the PDF API section. Depending on which features you are interested in, select the appropriate checkboxes and click Create Key.

You can optionally name your key to remind yourself which services the key corresponds to (i.e. merge-compless-api).

Embed your license key within the header of all your requests as the key-value pair: X-API-KEY: <your license key>

Now, about that sweet 1-2-3 workflow:

  1. (1) Make a request, by hitting the endpoint corresponding to your desired service
  2. (2) Check the status of your request until you get the completed response
  3. (3) Download the resulting file

That’s it!

This API involves an asynchronous operation where an initial request triggers a background process. Upon receiving a 202 Accepted response, the client needs to perform polling to check the status of the operation and retrieve the final result once it is completed.

  • 1. Trigger the Operation

    Send a POST request to any endpoint that triggers the operation (/pdf-merge/v1, /pdf-convert/v1, etc). The response will contain an operation id:

    {
    "id": "string"
}
  • 2. Poll for Status

    Use GET /operation/v1/{operationId}/status with the operation id to check the operation status from the response:

    {
              "status": "pending | processing | completed | failed",
              "progress": "number" (if status is processing),
              "error": "{ "message": "string" }" (if status is failed)
          }
  • 3. Download the Result

    Once the operation is completed, download the result using GET /operation/v1/{operationId}/download. The result file will be available for only 10 minutes after the operation is completed.