API Integration

    ServiceChannel API Documentation V2

    ServiceChannel API is a RESTful API. You need to have ServiceChannel account in order to use it and be authenticated while using the API. The following documentation covers core resources that are used to manipulate with the main entities.

    Working with APIs

    ServiceChannel provides two API environments:

    We strongly recommend you test your API using the Sandbox environment, and then use the Production environment once your APIs are fully tested and ready to go live.

    Instructions

    Below are instructions for Crud Operations, Collection Sorting, Postman Test, Authentication & Authorization, and Login & Registration.

    Crud Operations

    The following CRUD operations are used while calling ServiceChannel APIs

    • POST - To create or update resource
    • PUT - To create or update resource
    • GET - Get a resource or list of resources
    • DELETE - To delete resource

    Collection Sorting

    Sorting is activated by adding a &sort=ATTRIBUTE-NAME:SORT-DIRECTION URL parameter to the request URL to your Collection resource. Sort direction is either ´a´ (ascending) or ´d´ (descending). Example: &sort=Category:a

    Postman test

    You need to install the following application to your browser from the Google Store and import the collection in order to use the postman test collection.

    Authentication & Authorization

    Note: ServiceChannel API uses oAuth 2.0 authorization process. You can find protocol details here and helpful libraries here.

    Access to web APIs in ServiceChannel is implemented by using the OAuth 2.0 authorization code grant flow or an resource owner password flow. More information about Authentication and Authorization is available here.

    Login & Registration

    In order to use API you should firstly login and register your application here to retrieve your ClientId and ClientSecret.

    Note: user should have Super Admin or Provider Power User rights.