ServiceDesk Plus API



ServiceDesk Plus提供API的目的

API - 应用编程接口(Application Programming Interface)主要用于集成不同的应用以实现数据的共享。第三方应用可以使用我们提供的API,对ServiceDesk Plus进行操作,比兔,针对请求,它提供便利的方式以便用户在不登录ServiceDesk Plus的情况下,直接提交请求(不是通过发送邮件或通过自助门户提交请求),也可以对请求进行不同的操作(如:更新,删除,指派,添加注释等),它比发送邮件或Web提交等方式更加便利,使用也很简单。不需要登录SDP,即可查看请求明细。如果需要,您也可以创建自己特有的表单,使用API来创建,更新,删除请求。执行对应的操作之后,系统将返回执行操作的结果,其中包括操作的状态以及对应的请求的信息。

API类型及支持的操作

ManageEngine ServiceDesk Plus支持两种API,即:Servlet REST API。两种API的功能大体相同,Servlet API是基于HTTP表单的API,而REST API则完全满足REST 的规格要求,两种API执行的操作将按照定义的语法,进行调用。

Servlet API支持以下操作:

  • 添加新的请求编辑/关闭/删除/查看已有的请求,为已有的请求添加注释

  • 添加新的地点, 编辑/删除已有的地点。

  • 添加新的技术员,编辑/删除已有的技术员。

  • 添加新的请求人,编辑/删除已有的请求人。

  • 添加工作站/服务器,更新工作站/服务器,添加资产,更新/删除资产。

REST API 支持的操作有:

  • 添加新的请求编辑/关闭/删除/查看已有的请求。

  • 为请求添加新的注释编辑/删除/查看已有的注释。

  • 为请求添加工作日志,编辑/删除/查看已有的工作日志。

  • 添加新的变更,编辑/关闭/删除/查看已有的变更。

  • 基于不同的分类、状态、优先级等,导入请求。

  • 导入请求人/技术员的信息。

注意: REST API 同时支持 "事故/服务请求",而Servlet API 只支持"事故请求"。

Servlet 与 REST API的区别

Servlet API

REST API

servlet 基于表单,由外部应用提交表单中所输入的数据。其输出为XML格式。

输入数据为XML字符串,输出为XML格式的字符串。

HTTP表单数据提交到

http://<machine_name>:<port_number>/servlets/RequestServlet

REST API的通常格式为:

http://<servername>:<port number>/sdpapi/<module>

每个API的操作,使用用户名和密码进行认证。

每个操作的认证,通过技术员的API密钥进行认证。

支持的操作包括:请求(只有事故请求)、地点、技术员、请求人、及资产。

支持对请求(包括:事故和服务请求)、技术员、请求人和变更的操作,同时也支持部分管理配置的操作(导入请求)

将来的增强及扩展

  • 我们将不断增强API的功能,争取对ServiceDesk的所有模块都提供API。