Web API Integrations

Integrate S-easy into your business processes.

By using S-easy Web APIs, you can enable your own applications to work integrated with S-easy. You can find here which services you can use and how to use.

Which services serve by S-easy?

  • Authentication
  • Create new ticket
  • Get tickets by ticket owner
  • Get ticket details by id

How to use S-easy APIs?

In order to use these services, you must have an S-easy Account.

S-easy Web API link: http://api.s-easydesk.com

Service Details

GetAuthenticationToken

All services works with Bearer Token. You should get a token from following service by using your API Username, API Passwordand Channel Identifier which are display in your Account Setting page.

web Api

Example
POST /api/Authentication/GetAuthenticationToken 
{
    "username": "string",
    "password": "string",
    "channel": "string"
}
username: API Username which displays in the Account Settings page.
password: API Password which displays in the Account Settings page.
channel: Channel Identifier which displays in the Account Settings page.

Create a New Ticket

You can create a new ticket from your own applications like web sites, mobile or form applications.

Example
POST /api/Ticket/Create 
{
  "subject": "string",
  "description": "string",
  "parentCategoryId": 0,
  "subcategoryId": 0,
  "productId": 0,
  "productName": "string",
  "categoryName": "string",
  "customFieldList": [
    {
      "customFieldId": 0,
      "fieldValue": "string"
    }
  ],
  "owner": {
    "email": "string",
    "name": "string",
    "surname": "string",
    "phone": "string"
  }
}
  • subject: ticket subject.
  • description: ticket description.
  • parentCategoryId: Parent category Id. You can find it in the 'Category Settings' page after you create it.
  • parentCategoryId: Subcategory Id. You can find it in the 'Category Settings' page after you create it.
  • productId: You can find it in the 'Product Settings' page after you create it. You can send it as 0 if you don't have one or don't want to match with a product.
  • productName: You can find it in the 'Product Settings' page after you create it. You can send it as 0 if you don't have one or don't want to match with a product. It is just for the email notification.
  • CategoryName: Subcategory Id. You can find it in the 'Category Settings' page after you create it. It is just for the email notification.
  • customFieldList: You can fill it only if you have any custom fields. You can specify multiple custom fields.
    • customFieldId: You can fill it in the 'Custom Fields' page after you create it.
    • fieldValue: It depends on the custom field type. You can send only the text of the desired text to display.
  • owner: ticket owners data
    • email: ticket owners email address
    • name: ticket owners name
    • surname: ticket owners surname
    • phone: ticket owners phone

Get Ticket List By Owner

You can get a ticket list with an email address which belongs to an owner.

Example
GET /api/Ticket/GetByOwner 
/api/Ticket/[email protected]
Returns
[
  {
    "id": 0,
    "createDate": "2023-02-10T18:29:56.975Z",
    "ticketOwner": {
      "name": "string",
      "surname": "string",
      "email": "string",
      "phone": "string",
      "clientName": "string"
    },
    "subject": "string",
    "description": "string",
    "ticketState": "string",
    "resolvedDate": "2023-02-10T18:29:56.975Z",
    "resolvedBy": "string",
    "reopenedCount": 0,
    "isShared": true,
    "priority": "string",
    "isSurveySent": true,
    "assignedTo": "string",
    "category": "string",
    "subcategory": "string",
    "product": "string",
    "waitingTime": "string",
    "workedTime": "string",
    "customFieldList": [
      {
        "fieldName": "string",
        "fieldValue": "string"
      }
    ]
  }
]

Get Ticket By Id

You can get a specific ticket with a ticket Id

Example
GET /api/Ticket/GetById 
/api/Ticket/GetById?ticketId=4121
Returns
{
  "id": 0,
  "createDate": "2023-02-10T18:42:30.899Z",
  "ticketOwner": {
    "name": "string",
    "surname": "string",
    "email": "string",
    "phone": "string",
    "clientName": "string"
  },
  "subject": "string",
  "description": "string",
  "ticketState": "string",
  "resolvedDate": "2023-02-10T18:42:30.899Z",
  "resolvedBy": "string",
  "reopenedCount": 0,
  "isShared": true,
  "priority": "string",
  "isSurveySent": true,
  "assignedTo": "string",
  "category": "string",
  "subcategory": "string",
  "product": "string",
  "waitingTime": "string",
  "workedTime": "string",
  "customFieldList": [
    {
      "fieldName": "string",
      "fieldValue": "string"
    }
  ]
}