Skip to main content

Intro

Ingram Micro is a Licensing provider. This page guides you through the process of setting up an integration via the Ingram Micro API.

info

For any assistance, feel free to reach out to the Pia Team via Partner Support.

Prerequisites

You will need the following details before setting up your Ingram Micro integrations. (More details about these items can be found where you enter them in the sections below.)

  • Ingram API Url
  • Ingram Subscription Key
  • Ingram Marketplace
  • Ingram Username
  • Ingram Password

Obtaining the API Credentials from Ingram Micro​

You may follow the steps at Ingram Micro documentation: Ingram Micro API documentation

A short process is included below, however please be aware that the vendor application may change and you would be best to consult the vendor documentation for this information.

  1. Sign up for a developer account.
  2. Use the sandbox environment to learn and develop.
  3. Register your app.
  4. Access the production system.

Set Up Process

Here is a quick intro to setting up a new integration. Details for the fields specific to each service are on the pages linked below.

Summary of the set up process

  • Set-up integration
  • Test integration

Set-up integration​

  1. Log in to your Pia portal.

  2. In the left menu click on integrations

  3. The integration page opens.
    Search for Ingram Micro using the search bar at the top.

    Or, click on the "View All" button available in the All Integration section.

    This will open up a screen that displays all the available integrations where you can navigate to Ingram Micro.

  4. Click on the "Configure" button available in the widget for Ingram Micro. This will take you to the configuration page for Ingram Micro.

    In this page, you can add a friendly name for the configuration in the "Configuration Name" field.

  1. You will also see the following fields that need to be configured for Ingram Micro.

    • Ingram API Url: Enter the URL of the Ingram API including the API version with no following slash (e.g. https://api.cloud.im/marketplace/na - use this value if you aren't sure what to put in.)
    • Ingram Subscription Key: Enter your Subscription Key which is retrieved when creating an account with the vendor.
    • Ingram Marketplace: You can get the code from the Reseller control panel URL, for example, https://api.cloud.im/marketplace/na. In this example, the code will be us for a US based reseller.

    Here are some of the more common country codes:

    Country Code
    Australia au
    Canada ca
    England/United Kingdom uk
    New Zealand nz
    United States us
    • Ingram Username: Enter your username that is used to log into your Ingrammicro Account.
    • Ingram Password: Enter your password that is used to log into your Ingrammicro Account.
  1. Click Save to commit the settings. (If any mandatory fields have been left blank you will receive an error message, and the missed field will have a red box around them.)

Test integration​

After setting up your integration for Ingram Micro you will need to test the connection works.

  1. Click the Test Connection button to confirm the integration has been configured correctly.

  2. You should receive a Connection Successful! popup box. If you receive a Can't connect to service. message, double-check the configuration details and try again.

The Ingram Micro integration configuration is now complete.