API Integration

ServiceChannel API is organized around REST. It supports OAuth 2.0 for authorizing requests, accepts standard HTTP verbs, and returns JSON-formatted data.

Using the ServiceChannel Developer Portal you can update to update work orders, process proposals, generating invoices, and more.

Integration Overview

Before navigating to the Developer portal, you can find information about API integration in the Integration section of ServiceChannel.

The Integration section has the following subsections:

Overview
App Registration
Permissions
WebHooks

To add the Integration section, contact your ServiceChannel representative.
Once the Integration section becomes active, only users with the Provider Automation Admin user role can view and manage it.

How to Access the Integration Section
Log in to your ServiceChannel account. From the hamburger menu, select Administration > Integration.

Overview

This page provides information that you may need while working with the ServiceChannel API:

A link to the Developer portal where you can learn API basics, read guides and news.
A link to the API Reference page where you can access API methods in the production environment.
A link to the Sandbox Mode page where you can learn how to experiment on API methods in the SB2 environment.

On the right side of the Overview page, you can find your ProviderID.

Registering an Application

On this page, you can find a link to the App Registration page at the Developer portal. Here, you can also add API client information.

How to Add New Client
On the App Registration page, click the Add New Client button. In the Add API Client Info window, fill the necessary fields: Click Save.

Permissions

On this page, you can download a contractor request form and view which permissions subscribers have set for you.

Downloading the Contractor Request Form

How to Download the Form
On the Permissions page, click the Download Form button. Find the file in the Downloads folder of your computer.

About Permissions Table

This table includes subscribers’ names and unique identification numbers, as well as XML permissions that they have configured for you.

Permission		Description

Permission		Description
Incoming XML	Active	When turned on, it allows a subscriber to switch on any permissions for a certain provider.
	Note Creation	Allows a provider user to create work order notes via XML.
	ScheduleDate Update	Allows a provider user to change a scheduled date via XML. This permission affects both XML and API requests.
	Workorder Create	Allows a provider user to create work orders via XML. This permission affects both XML and API requests.
	NTE Update	Allows a provider user to change an NTE amount via XML.
	Status Update	Allows a provider user to change the work order status via XML.
	Set status to COMPLETED_PENDING	Allows a provider user to change the work order status to Completed Pending via XML.
	Set status to COMPLETED	Allows a provider user to change the work order status to Completed via XML.
	IVR Check IN/OUT	Allows a provider user to make check in/out via XML. This permission affects both XML and API requests. When this permission is disabled for a provider, they can make check in/out via API, but they cannot set the certain time of check in/out.
	Allow to use MAIL_TO	Allows a provider user to add email recipients while creating a work order note.
Outgoing XML	New WO send	Notifies a provider via XML once a work order is created.
	New Note sent	Notifies a provider via XML once a work order note is created.
	New IVR sent	Notifies a provider via XML once a check in/out record is created.