Skip to content

Introduction

REST API acts as a bridge between ServiceDesk Plus and other applications. The communication happens via HTTP Request. The REST API authenticates users using API Key, thus eliminating the need for users to separately log into ServiceDesk Plus to carry out the required operations. The requests are sent using HTTP Method and the operations performed using REST API are based on this.

Authentication

API Key

It is used for authentication purpose. Every user with login permission can generate a authtoken with/without expiry date. A Technician with ‘SDAdmin’ role can generate the authtoken for other users as well. It is through this authtoken, users are identified and allowed to perform operations based on their role. This authtoken can be sent in Request Header as authtoken. If the login credentials of the User is disabled, the correspoding authtoken will be deleted.

Generate API key

  1. Go to ‘Admin -> Technicians/Users’.
  2. To generate an API key for an existing user, click the Edit icon beside that user.
    To generate the API key for a new user, click the Add New User link, enter the user details and provide login permission.
  3. Click Generate link under the API key details block. Select a time frame for the key to expire using the Calendar icon, or simply retain the same key perpetually.
  4. If a key is already generated for the User, a Re-generate link appears.
    A time frame for the key is selected, within which the key expires. (The time frame shows the date, month, year and time (in hours and minutes))