What's New with the Mimeo Print API

Mimeo's enhanced REST API has launched

We've been working hard to develop and expand our REST API. The information on this page provides an overview of what's new.

  1. Authentication
  2. Documentation
  3. Endpoints
  4. Payment Types
  5. Call Responses

For support, email apis@mimeo.com.


Subscription-based Authentication

The older production API uses basic authentication. Our latest version allows you to generate a subscription key using your Mimeo credentials.

  1. Visit our Help section for a step-by-step guide on how to generate your key.
  2. Add this subscription key as a variable in the header named “Ocp-Apim-Subscription-Key”.
  3. Pass this parameter in the header of each API call.

Enhanced Service Documentation

This portal supports a Try It feature that lets you retrieve blank calls and send test calls into our API, via the developer portal (this site).

  • View the API service area of this site for full descriptions of each service and sample code in your language of choice (Curl, C#, Java, Javascript, ObjC, PHP, Python and Ruby)
  • New Endpoints

    Our APIs now have revised endpoints for some services. Please review each service you use for changes.

    1. Orders endpoints now use a “/ord” prefix
    2. Example: https://connect.mimeo.com/2012/02/Orders/GetShippingOptions

      is now: https://print.api.mimeo.com/ord/Orders/GetShippingOptions

    3. StorageService endpoints now use a “/dir” prefix
    4. Example: https://connect.mimeo.com/2012/02/StorageService/FindStoreItems

      is now: https://print.api.mimeo.com/dir/StorageService/FindStoreItems

    5. Call for NewDocument is more RESTful
    6. Example: https://connect.mimeo.com/2012/02/StorageService/NewDocument?DocumentTemplateId=3930ea12-6675-43ad-8b1c-94c4177cc980 

      is now: https://print.api.mimeo.com/dir/StorageService/NewDocument/3930ea12-6675-43ad-8b1c-94c4177cc980

    Payment Method Types

    When quoting or placing an order, you no longer need to supply _type as part of the payment method detail. Now, it's a simple attribute.

      UserCredit example::

      "PaymentMethod": {
          "PaymentMethodType": "1"
        }

      Corporate Account example::

      "PaymentMethod": {
          "PaymentMethodType": "2" 
          "CorporateAccount": {
              "Id": "00000000-0000-0000-0000-000000000000"
          }
        }

      Corporate Credit Card on file example::

      "PaymentMethod": {

          "PaymentMethodType": "CreditCard" 

          "UserCreditCardReferencePaymentMethod": {
              "Id": "00000000-0000-0000-0000-000000000000"

          }
        }

      Revised Responses

      1. Print File Upload response:
      2. <RESTStorageItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="StorageFolder">

        <FolderId>51a468ff-9eb3-4231-85b9-3a0a9b0a00b2</FolderId>

        <Name>test2019</Name>

        <Created>2019-06-05T23: 34: 32.93Z</Created>

        <Files>

        <PrintFile>

        <FileId>a84c3e8b-8d07-4b19-9725-5d5b3ff468fb</FileId>

        <Name>MyUploadedFile.pdf (4)</Name>

        <DateCreated>2019-06-24T20: 58: 22.537Z</DateCreated>

        <IsBroken>false</IsBroken>

        <LastModified>2019</LastModified>

        </PrintFile>

        </Files>

        </RESTStorageItem>