Web 服务 API 简介

本部分将提供访问和使用 Web 服务 API (WS API) 所需的信息。 WS API 当前支持 SOAP 协议。

WS API 将提供用于与 Service Desk 平台交互的编程方法。您可以更改 Service Desk 应用程序中所管理实体（如故障单、配置项和知识文章）的数据。

要使用此文档，您应对软件开发、Web 服务和 Service Desk 用户界面有基本了解。只有当您的组织被授予 Web 服务访问许可时，才能使用该文档中所述的任意功能。

如果您无法访问该文档中描述的功能，请联系服务台支持人员。

注意：建议使用 SOAP UI 客户端与 ServiceAide Cloud Service Management Web 服务进行联接。有关使用 SAOP UI 客户端的详细信息，请参阅 http://www.soapui.org。

本节包含以下主题：

标准遵从性

实施 WS API 是为了遵从以下标准规范：

标准名称	网站
简单对象访问协议 (SOAP) 1.1	http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
Web 服务说明语言 (WSDL) 1.1	http://www.w3.org/TR/2001/NOTE-wsdl-20010315

开发平台

该 API 已经过验证，可以用于 J2EE 1.6 和 Apache Axis2 开发环境。在此文档中，我们提供了 Java 示例。 Java 示例基于 Apache Axis2 1.5.1 和 JDK 1.6 环境。有关详细信息，请访问 http://axis.apache.org/axis2/java/core/。

API 支持策略

我们建议您的新客户端应用程序使用最新版本的 Service Desk WSDL 文件，以充分利用更丰富的功能以及更高的效率所带来的好处。您可以访问 Service Desk Web Service URL 来获取最新的 WSDL。

例如，您可以通过访问此 URL 来获得服务请求 WSDL：https:// {servicedeskcontexturl} /NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl。在此示例中，{servicedeskcontexturl} 是您调整后的登录 URL。要为您的实例确定调整后的登录 URL，请考虑以下示例：

您是访问美国生产实例的用户。通常，您登录到 https://sm1.saas.ca.com。要访问服务请求 WSDL，您可以访问以下 URL 之一：
- https://sm1.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl
您是访问美国分段实例的用户。通常，您登录到 https://sm1s.saas.ca.com。要访问服务请求 WSDL，您可以访问以下 URL 之一：
- https://sm1s.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1s.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl

注意：具体的 URL 取决于您实际访问的实例。请联系支持团队联系获取准确的 URL，或使用提供的示例构建 URL。

发布更新版本的 Web 服务时，请按照以下步骤从现有的 WSDL 文档重新生成客户端代码：

使用 WSDL2JAVA 实用程序重新生成客户端存根。

从现有/最新版本的 WSDL 文档更新客户端类。
编译并运行客户端类。

向后兼容性

ServiceAide Cloud Service Management 不保证针对一个 WS API 版本编写的应用程序可应用于未来的 API 版本。随着我们对 API 的进一步增强，经常需要对方法签名和数据表示法进行更改。

不过，我们一直在努力使该 API 与之前的版本保持一致。这有助于确保您可以在进行最少改变的情况下将应用程序迁移到更新版本的 API。