REST API



关于REST API

REST Representational State Transfer )的缩写。ServiceDesk Plus除了提供Servlet API之外,也提供REST API。has 它们的功能有的类似,有的有些不同,请参照Servlet与REST API的差别 ]。REST API 无需登录ServiceDesk Plus,即可执行相应的操作。从而有利于您第三方集成,实现帮助台联动的自动化。

REST API 所执行的操作依赖于 'operation'参数,并通过HTTP POST方法,发送至所指定的URL。格式为

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

 

REST API时通过API密钥进行认证的,每个操作都有提供API密钥。该API密钥将依据技术员产生。密钥中包含有技术员所属的角色权限,因此,只能执行对应技术员权限的操作。一旦密钥产生,需要手动将密钥传输到集成的应用中,一般集成的应用能通过该API密钥,执行相应的API操作。如果密钥失效(比如:过期或技术员被禁用),API 操作将会返回失败的信息。

 

 注意

1. 只有管理员才能为具有登录权限的技术员生成API密钥。

2. 如果某个技术员的登录权限被禁用,则相应的API密钥将被删除。

3. API操作将根据技术员的相应角色,执行相应的操作。

 

目前,支持使用XML字符串作为输入和输出的格式。输入数据将被设置为XML字符串,连同API密钥和操作类型的名称一起,提交到相应的URL。

 

生成API密钥

ServiceDesk Plus与集成应用之间的认证是通过API密钥进行的。每个可登录的技术员都可以生成一个唯一的密钥。

  1. 点击 管理 -> 技术员。

  2. 如果要为已有的技术员生成API密钥,可点击相应技术员的编辑图标
    如果要为新的技术员生成API密钥,可点击新建技术员的链接。

  3. 在技术员的API密钥部分,点击生成按钮,选定该密钥的有效期,即可生成密钥。
    如果已经为该技术员生成过API密钥,可点击重新生成按钮,生成新的密钥。

请记录好生成的密钥,以便日后使用。

 

REST API支持的操作

REST API 支持的操作可以分为以下几大类:

  • 对请求的操作: 添加新的请求、提取请求、指派请求、获取请求、获取会话、添加附件、获取请求通知、添加/编辑/获取解决方法。

  • 特定请求的操作:  

    • 编辑、关闭、删除及查看已有的请求。

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

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

    • 获取请求相关的会话。

    • 为请求添加附件。

    • 为请求添加、编辑、获取解决方法。

    • 提取、指派请求。

    • 回复请求。

    • 获取请求相关的通知。

  • 技术员相关的操作: 获取技术员的信息。

  • 请求人相关的操作: 获取请求人的信息。

  • 管理相关的操作: 导入请求分类、子分类、条目,导入请求状态、导入请求级别、导入请求模式、紧急度、优先级,导入请求模板、支持组等信息。

  • 变更相关的操作:添加变更,编辑变更等

  • CMDB的API