Table of Contents
As discussed in the introduction page, Soft-Pak is our waste operations software solution that allows customers access services such as billing, routing, and other operational functionalities through desktop, laptops and tablets. This allows our customers to connect with our system on the go. For this to work as intended, Soft-Pak is integrated with our Collections API. This makes it easy for our customers to upload and update routes and customer information through Soft-Pak.
There are three major ways we share information through APIs with Soft-Pak:
- Schedule: This controls the collections tab in our portal. This gives our customers access through soft-Pak to upload new routes and/or make changes to existing routes.
- Stop: This controls the Collection Stop button in the administration tab. this section shows our customers clients information such as names and addresses. Through Soft-Pak, our customers are able to upload new customers and make changes to existing ones.
- Reviewer: This control is designed to give you information back from reviews performed in 3rd Eye. Reviewers go through the events captured to see if there are any abnormalities that matches the customers definition such as Bulks and Overloads. When these are discovered, the reviewers highlight the event, which triggers the API to send this information back to our customers through Soft-Pak.
Understanding Soft-Pak Setup in 3rd Eye
When looking at a Soft-Pak customer, we should see in the Organization Tab that the Collection API is checked at the top-level division for the company as highlighted in the blue and red boxes below. If a customer will be using our service bureau for reviewing, they should have the Service Bureau and AI review boxes checked as highlighted in the green boxes below.
Soft-Pak sends us the list of company names that 3rd Eye needs to create as divisions. 3rd Eye creates a division named "Soft-Pak" as a place holder that contains each of the company divisions as shown in the red box below. This information is then given to us at 3rd Eye to integrates with the divisions and subdivisions that will be created under it as we can see in the red box from the image below.
For collection API to work, the customer must have a collection API Key visible in the Companies tab as highlighted int he blue box of the image below. Without the Collection API Key, Soft-Pak will not be able to use the collection API.
The red box in the image below highlights a special configuration needed to integrate with Soft-Pak. To find more details about this configuration and another supporting document, search for "System Administration - Setting up Soft-Pak Integration".
Note: When integrating with Soft-Pak, it is important that the JSON is configured the right way. The configuration is important because there are other features and functionalities that are dependent on this configuration to work properly.