Print API Help


Get started with our API

Other Resources

  1. Sign up for an account on the Mimeo Print website.
  2. Use those credentials to register for an API key.
  3. Identify and test the API calls you want to use.

For support, email apis@mimeo.com.


How to Create an Account for the API


The information in this document will help you establish an API account for testing. Please note that this is a work in progress, and content will change as we continue to enhance our new API and accompanying documentation.


Step 1 - Sign up for a new Mimeo Print account

The first step is to create a Mimeo Print account in one or more regions. If you already have an existing Mimeo Print account, you can skip this step.

  1. Visit the Mimeo Print website and sign up for an account in sandbox first. Once you are ready for production deployment, do the same thing in production. (You can freely test in sandbox, and we will not produce any physical orders nor charge you for them.)

    NOTE: In general, we recommend setting up dedicated account for your API implementation, and sharing all print and document content to it.

    Region

    Production

    Sandbox

    US

    https://my.mimeo.com

    https://my.sandbox.mimeo.com

    UK

    https://my.mimeo.co.uk

    https://my.sandbox.mimeo.co.uk

    DE

    https://my.mimeo.de

    No sandbox instance (use US or UK)

  1. Click the circle next to the shopping cart in the upper right corner of the screen, choose Account and fill out Account Address.
  2. Communicate the account email to us, so that we can enable any corporate details required for your environment.
  3. Manually upload a few print files, and create documents for testing.

Step 2 - Sign up for an API account

Once the account exists, you can use it to generate your API key. If you ever forget your key, you can simply follow this process to retrieve it.

  1. Navigate visit the appropriate Connect site to generate a region-based API key. Log into the page using the Mimeo basic authentication details you created in step 1.

    Region

    Production

    Sandbox

    US

    https://connect.api.mimeo.com

    https://connect.api.sandbox.mimeo.com

    UK

    https://connect.api.mimeo.co.uk

    https://connect.api.sandbox.mimeo.co.uk

    DE

    https://connect.api.mimeo.de

    No sandbox instance (use US or UK)

  1. Read our API documentation for both our sandbox and production API environments.


Step 3 - Identify and test the API calls you want to use.

At this point, you're able to start issuing API requests to the appropriate endpoint. Be sure to include your API key in the header, under the name Ocp-Apim-Subscription-Key.

The spectrum and order of calls differs based on what features you need to use. The diagrams below show the two most common uses. The API also offers many different methods you can use to manage your users and items.

For support, please email apis@mimeo.com.

Upload new PDF files into the My Print File section of your library Create a new document using your new PDF file and a Model Document template Request the unique identifier for  libary item via its friendly library name value Request the unique identifier for libary item via its reference value Return a list of all library items in a specific folder Return the fully populated definition for an existing item in your library Return the empty definition for an existing item in your library Return all available shipping methods available for your recipients Submit your order to Mimeo for fulfillment Request an empty definition with all available fields for an order Return a price quote for your order before submitting it Request tracking details for a specific order that has been produced and shipped Request full historical details for a specific order that has been produced and shipped Request current status for an order submitted to Mimeo