Public API

If you would like to explore or try out our Public API, click here.

REST PRINCIPLES

ServiceBridge Public API is created using the REST principles. 

URLs are created using plural entity names (e.g. customersmarketingCategories) and version number (e.g. v1). These methods are supported:

  • GET for retrieve a list of entities. (e.g. GET /api/v1/customers)
  • GET for retrieve a single entity by ID. (e.g. GET/api/v1/customers/15)
  • POST for creating an entity. (e.g. POST /api/v1/customers/)
  • PUT for updating a single entity by ID. Partial and full updates are supported. (e.g. PUT /api/v1/customers/15)
  • DELETE  for deleting a single entity by ID. (e.g. DELETE /api/v1/customers/15)

CREATING USER CREDENTIALS

Before starting using, API user should have UserId / Password combinationIt can be created in SB360: 

  1. Go to Settings → Public API Settings
  2. Press "+". Add New API User dialog will show.
  3. Enter details: 
    1. System User. It defines what user account should be associated with the API user. In Audit History, you will see, that this user did the changes to the data. Plus, this user's access permissions will be used to grant or to forbid access to a specific data (e.g. a user can have full access to the customers' data, but have no access to the accounting data). 
    2. API User Alias. It's the optional name that will be visible in audit history (e.g. when new customer will be created). If not provided, the system user name will be used.
    3. Password. In order to do not share the original user password, need to define the API user password, what is used only to access the API methods.
    4. Active. If set to false, an API user account may be temporarily disabled.
    5. When a user is created, API User Id is provided. It will be the main unique user identifier when authenticating the user:

 If you would like to explore or try out ServiceBridge Public API, click here.

AUTHENTICATION

All the methods, except Login and Logout are secured. To access these methods, a valid sessionKey GET parameter should be passed in each request (e.g. /api/v1/customers/?sessionKey=5230f77caf67d27b49dbb8f098a7d381cc7f872).

sessionKey is generated when calling a Login method and has 30 minutes sliding expiration. It means, that on each request it's expiration is moved to 30 minutes.

REQUEST LIMITS

API has request limits per IP address:

  • 50 requests per second
  • 2000 requests per hour

ERROR CODES

When an exception occurs, error message and error code are returned.

List of error codes:

 If you would like to explore or try out our Public API, click here.

 

Have more questions? Submit a request

7 Comments

  • 0
    Avatar
    Alex Kelley

    It's exciting to be offering this new functionality now.  Very useful for developers in extracting data from or adding data to a ServiceBridge account.

    Edited by Alex Kelley
  • 0
    Avatar
    Sagar Jain

    How to create work order using API ?

  • 0
    Avatar
    Felipe Valdivia

    Where to find the Public API option ??? 

  • 0
    Avatar
    ServiceBridge Support Admin

    Sagar, the WO objects can be created via the POST /api/v1/WorkOrders method. For more info you should look at the https://cloud.servicebridge.com/developer/index#!/WorkOrders/WorkOrders_Post method details.

  • 0
    Avatar
    ServiceBridge Support Admin

    Felipe, please create a support ticket if you don't see Public API option enabled for your account. All Public API methods are available here https://cloud.servicebridge.com/developer/index without limits, but the Public API access itself should be enabled on your account level first. Are you on trial?

  • 0
    Avatar
    Bob Graw

    We have a customer (and maybe more than one) that would like us to integrate with ServiceBridge.

    Is there a sandbox where you can try the API?

    Can you search for Customers by phone number?

     

  • 0
    Avatar
    Kevin Skinner

    Hi Bob, 

    Good questions! We would be happy to create a trial that you can use to explore the API. 

    Give me a call at (312) 374-4002, or contact sales@servicebridge.com, and we'll set it up for you. 

    Best, 

    The ServiceBridge Team 

Please sign in to leave a comment.