Onboard an Integrator

Scenario: you have a third party developer who you'd like to send you orders (aka an integrator). The following steps will guide you on how to on board them.

Create the integrator

In this step we will create the integrator and set up their credentials - initially as a test order creator then as a live order creator later in these steps.

• Log into the workflow as a Partner
• In the left hand panel click Customers > Integrators
• Click the plus sign to create a new integrator

• Enter the key information (1,2,3) - ensure that Test Orders (2) is enabled

  

• Click on HTTP API (4)
• Enable Http
• Copy the connection credentials - you'll supply these to the integrator in the next step
  • note that you will have to click on the eye icon to make the Secret visible (or use the copy button)

Integrator access and documentation

• Provide the relevant details to the integrator
  • the connection details from above

  • This URL to our API documentation:

    https://workflow.myprintstreet.com/apiguide

Verify the orders

• verify that the orders that the integrator is sending you are;
  • are arriving in the workflow
    • Log in as network owner > go to Order manager > Filter
    • click "Show Test Orders"
    • Click Search - the test orders should be listed
  • are correctly populated with products and details
  • are free from errors
• Contact support if the orders are missing or you're struggling to diagnose issues with the order.

Enabling production orders

• Log into the workflow as a Partner
• In the left hand panel click Customers > Integrators
• Click your new integrator to open the details panel
• Deselect "Test Orders"
• Save