How to Test Your Integration Using Our Sandbox Environment

If your company uses exports and integrations in ServiceTrade, our changes to record IDs may affect your integration.

This article will give you an up-to-date list of integrations we have already tested and approved, and walk you through how to test your integration using our sandbox environment. 

Specific Integrations Already Tested

In preparation for this update, we have already tested specific integrations. These integrations will not be affected and no further testing is required on your part.

• 1. PartsLedger
  2. ServiceForms
  3. ServiceTrade Toolbox Tools
  4. Service Timecard (“New Timecard”)
  5. Timecard Tool (“Old Timecard”)
  6. QuickSight
  7. Invoice Link Payments
  8. QuickBooks Desktop Integration
  9. QuickBooks Online Integration
  10. Sage Intacct Integration
  11. ComputerEase Connector
  12. Avalara Integration 
  13. Service Reviews (Nearby Now)
  14. TomTom
  15. Zapier
  16. Chrome Extender

Partner Integrations

We have spoken with many of our partners and confirmed that their integrations work. Confirmed integrations include: 

1. Sage 100 Contractor by EI Dynamics
2. Sage 100 Contractor by Pixis
3. Sage 300 CRE by Pixis
4. Spectrum by Ryvit
5. Sage Intacct by LBMC
6. Sage 100 ERP by DSD

Using the Sandbox to Test Your Integrations

To support customers and partners who wish to test their integrations to ServiceTrade's web application and API, we have made a sandbox ServiceTrade environment available at https://idtest.servicetrade.com for a limited time for testing purposes.  This sandbox contains a copy of ServiceTrade production data as of January 2, 2022.  All newly created IDs for all records in this environment will be 64-bit integers.

Sandbox web URL:  https://idtest.servicetrade.com

Sandbox API URL:  https://idtest.servicetrade.com/api

You can log into this environment with any existing ServiceTrade credentials.  This environment is available to ServiceTrade customers at no charge.  

If you wish to use this sandbox environment, please note the following:

• Application performance may be different than the normal ServiceTrade environment and is not related to the use of larger IDs.
• ServiceTrade's technician mobile applications cannot be used in this sandbox environment.
• Delivery of all emails sent by ServiceTrade is disabled in this environment.
• ServiceTrade's built-in accounting system integrations with Sage Intacct, QuickBooks Online, and QuickBooks Desktop are disabled in this environment.
• All existing webhook subscriptions that were copied from ServiceTrade production data have been removed.  To test an integration that relies on webhooks, please follow the instructions in 'To test your webhook listeners' below.

Adjusting Your Code

You should only need to change the base URL for the ServiceTrade API.  All other information (credentials, etc) will typically remain the same.  

If you use the ServiceTrade Node.js SDK, you can alter the base URL by specifying the optional `baseUrl` parameter, as follows:

const ST = require('servicetrade-nodejs')({
    baseUrl: 'https://idtest.servicetrade.com',
    username: 'YOUR-USERNAME',
    password: 'YOUR-PASSWORD'
});

If you use the ServiceTrade PHP SDK, you can alter the base URL by specifying it as the optional third parameter, as follows:

$ST = new Servicetrade(
   'YOUR-USERNAME',
   'YOUR-PASSWORD',
   'https://idtest.servicetrade.com/api'
);

Testing Your Integration

If your integration interacts with records that users create or update in the ServiceTrade web UI:

In the sandbox web UI, create new records that your integration will interact with.
For instance, if your integration interacts with jobs in ServiceTrade, you should create one or more new jobs which will receive a 64-bit ID.

Then, use the workflows in your integration that interact with those newly created/updated records, and confirm that they work properly.

If your integration creates new records in ServiceTrade:

You should connect the new record creation workflow in your integration to the sandbox environment to confirm that it works properly.

Testing Your Webhook Listeners

All existing webhook subscriptions that were copied from existing production data have been removed from the sandbox environment.  This was done intentionally, to prevent those existing webhooks subscriptions from sending notifications to your production webhook listeners, which might not know how to distinguish between messages from a production environment and messages from a sandbox environment.

If your integration involves webhook listeners, you will need to add one or more new listeners to the ServiceTrade sandbox, as follows:

1. Log into the ServiceTrade sandbox as a user with account administrator permissions.
2. In the upper right corner of the ServiceTrade web user interface, click on your avatar, then choose 'Account Settings' from the menu that appears.
3. In the 'Act on this account' menu on the right side of the screen, click the green 'Add a Webhook' button.
4. In the modal window that appears, type the URL of the webhook listener that you wish to test, then click the green Save button.
5. Repeat steps 1-4 for each additional webhook that you need to test.

More information about creating webhook subscriptions is available in the ServiceTrade webhook notification API documentation.

Testing Your Data Warehouse Connections

Users who use BI tools other than Amazon Quicksight may wish to test those BI tools against the data warehouse sandbox that is connected to https://idtest.servicetrade.com. To test those tools, you can make a connection to the data warehouse sandbox as follows:

server hostname: redshift-1.servicetrade.com

server port: 5439

database name: idtest

Your schema name, username, and password will be the same as for the regular data warehouse.

If you wish to use the data warehouse sandbox, please note the following caveats:

• This data warehouse sandbox is populated with data from the https://idtest.servicetrade.com sandbox environment, NOT your production ServiceTrade environment.
  To test your BI tools, you should create new records (jobs, quotes, invoices, etc) in https://idtest.servicetrade.com, then confirm that those newly created records (with large IDs) are handled properly by your BI tools.
• The sandbox data is updated once per day, around 11 pm Eastern time (unlike the production data warehouse, which is updated every 4 hours.)
• IMPORTANT: To use the data warehouse sandbox, you must contact support@servicetrade.com to request access.  

Need More Help? 

Reach out to ServiceTrade Support at support@servicetrade.com.