Online Documentation

Service Provider Onboarding


sureEcosystem can automate the onboarding of a service provider with a dispatch software provider. The dispatch software provider must create the methods below and provide the http endpoint to sureEcosystem. During the registration process, the service provider will select their dispatch software provider. With the dispatch software selected, sureEcosystem can make the appropriate method calls to onboard the service provider. Once a service provider has registered, sureEcosystem will forward their registration information to the selected call provider for approval. Once the call provider approves, sureEcosystem will forward the service request to the dispatch software provider.

Service providers register for sureEcosystem at https://www.sureecosystem.com.

API Methods

Authenticate Service Provider in Dispatch Software
Parameters Username, Password
Returns Company Id for Service Provider if successful
Sample Response {"success":true,"company_id":522}

sureEcosystem uses this method to retrieve the unique id of the service provider in the dispatch software.


Collect Customer Key
Parameters Company Id, Customer Code
Returns Id of Customer in Dispatch Software
Sample Response {"success":true,"customer_id":3436}

The customer key will be stored in sureEcosystem. During the service dispatch request, this value will be passed so that the dispatch software provider can link the call to the correct customer.


Activate sureEcosystem
Parameters Company Id for Service Provider
Returns Returns True if activated
Sample Response {"success":true,"activated":1}

This call allows sureEcosystem to activate the service provider for sureEcosystem in the dispatch software provider