Guide Purpose:

• This guide IS designed to:
  • Show how to setup Soft-Pak integration with 3^rd Eye for the collection API and a review use case
• This guide IS NOT designed to:
  • Show how to understand JSON and how its formatted.

Received Request to Set-Up Integration

*Note: A request must be received to setup Soft-Pak integration and should contain the information as listed below

1. Customer name
2. What URL they need the information sent back to
   1. Stop status URL (eg: http://54.149.143.145:8080/testCallback)
   2. Reviewers call back URL (eg: https://devtest.soft-pak.com/ThirdEyeProxy/api/tf/reviewer/activity)
3. What companies they need set-up
   

How to Setup Soft-Pak Collection API Integration in 3^rd Eye

How to Get to Setting Up Soft-Pak Parent Division

1. Click on Administration Tab
2. Select the configuration button
3. Select the Organization button
4. Scroll or Search for Tenant name
   1. Select Tenant
5. Select the top-level Division
   1. Verify Collection API (Service Bureau and AI Review if reviewer activity is requested) are enabled.
   2. If its not, please check the boxes (as highlighted in the BLUE box in the image below) for Soft-Pak to enable them.
6. Click the “New” button
   

How to Set-Up Soft-Pak Parent Division

1. Fill out the parent division name as Soft-Pak
2. Input the address of the Tenant and the time zone
   1. Fill all information within the BLUE highlighted box.
3. Click the “Create” button
   

How to Get to Setting Up Soft-Pak Companies

*Still under the Administration tab and Organization button

1. Scroll or Search for Tenant name
   1. Select Tenant
2. Select the Soft-Pak Division
3. Click the “New” button
   

How to Set-Up Soft-Pak Companies

*Repeat this process for every Company needed to be created for Soft-Pak.

1. Fill out the Soft-Pak company name provided in the request sent.
   1. In the image below, I used Company-01 as the company name
2. Input the address of the Tenant and the time zone
   1. Fill all information within the BLUE highlighted box.
3. Click the “Create” button
   

How to Configure Soft-Pak Collection API Integration in 3^rd Eye

Collection API Key Configuration

*Still under the Administration tab

1. Select the Companies button
2. Scroll or Search for Tenant name
   1. Select Tenant
3. Verify a collection API Key is generated
   1. If not generated, click on the “Generate New Key”
   2. Attach the key to the request email and forward back to Soft-Pak (This key is required to complete integration with Soft-Pak)
      

URL Configuration

*Still on the same page as Collection API Key Configuration

1. Insert the Stop Status Callback URL included in the request (This is included in the email request if customer uses Stop Status)
   1. Stop Status sends back every stop that occurs during a route
   2. Select the status the customer needs to be sent from the boxes on the right
      1. Keep in mind that Soft-Pak only receives work completed and extra stop completed as highlighted in the green box below
      2. If any other status needs to be checked, please confirm with your supervisor
   3. Once selected, the JSON automatically updates with this selection as seen in the RED highlighted box in the image below
2. Insert the Reviewer Callback URL included in the request
   1. Reviewer Callback sends back every event our reviewers complete
   2. Once inserted, the JSON automatically updates as seen in the BLUE highlighted box in the image below
3. Click update
   

JSON Configuration

*Still on the same page as Collection API Key Configuration

1. Insert the payload for the review case(s) (reference the JSON payload standards guide in Zingtree for review case payloads) in the JSON