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 ACTIVATE YOUR ACCOUNT button to confirm your email address.

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

1. You have the option of creating a free, 30-day trial license key, that will work with any of our services you choose to try.

The services we offer are shown under the Permissions – PDF API section. To generate your new license key, select the service(s) you're interested in testing out, by choosing the appropriate box(es) and clicking the Create Trial Key button. This type of license key is limited to one per account. You will be able to see the days remaining in your trial, in the Status column of the License table.

2. Once you have created the free 30-day trial license key as described in 1 above you have the option of purchasing a permanent license key, without an expiry.

Choosing this option will allow you to create unlimited number of keys and edit permissions of an already created key. You can do this by contacting our Sales Department via the completion of our online form.

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. Someone from our sales department will get back to you and propose a personalized solution.

NOTE: Regardless of what type of license key you choose to generate, you can optionally name it to remind yourself which service(s) it corresponds to (i.e. merge-compless-api etc.).

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.

Notes

1. From this point on, include the Swagger example calls for Status check and Download - the same way the page looks now.