Introducción a la API de servicios Web

Esta sección proporciona la información necesaria para acceder y utilizar la API de servicios web. La API de servicios web actualmente es compatible con el protocolo SOAP.

La API de servicios web proporciona una forma programática de interactuar con la plataforma del Centro de servicio al usuario. Se pueden cambiar datos para entidades como Tickets, Elementos de configuración y Artículos de conocimiento que se gestionan dentro de la aplicación del Centro de servicio al usuario.

Para utiizar este documento, es necesario tener un conocimiento básico sobre el desarrollo de software, los servicios web y la interfaz de usuario del Centro de servicio al usuario. La funcionalidad descrita en este documento solo está disponible si a la organización dispone de una licencia de acceso a los servicios web.

Si no se puede acceder a las funciones que se describen en este documento, póngase en contacto con el soporte del Centro de servicio al usuario.

Nota: Se recomienda utilizar el cliente de la interfaz de usuario de SOAP para la conexión con los servicios Web de ServiceAide Cloud Service Management. Para obtener más información sobre el uso del cliente de la interfaz de usuario de SOAP, consulte http://www.soapui.org.

Esta sección contiene los siguientes temas:

Conformidad de estándares

La API de los servicios Web se implementa para cumplir las siguientes especificaciones de estándares:

Nombre estándar	Sitio Web
Simple Object Access Protocol (SOAP, Protocolo de acceso a objetos simples) 1.1	http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
Lenguaje de descripción de servicios Web (WSDL) 1.1	http://www.w3.org/TR/2001/NOTE-wsdl-20010315

Plataformas de desarrollo

La API se ha validado para trabajar con entornos de desarrollo J2EE 1.6 y Apache Axis2. En este documento, proporcionamos ejemplos en Java. Los ejemplos de Java están basados en Apache Axis2 1.5.1 y JDK 1.6. Para obtener más información, consulte http://axis.apache.org/axis2/java/core/.

Política de compatibilidad con API

Se recomienda que las nuevas aplicaciones de cliente utilicen la versión más reciente del archivo WSDL del Centro de servicio al usuario para explotar al máximo las ventajas que ofrecen unas funciones más sofisticadas y una mayor eficiencia. Puede buscar el archivo WSDL más reciente accediendo a la URL de servicios Web del Centro de servicio al usuario.

Por ejemplo, se puede obtener el WSDL de solicitud del servicio en esta dirección URL: https://{servicedeskcontexturl} /NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl. En este ejemplo, la dirección {servicedeskcontexturl} es su URL de inicio de sesión ajustado. Para identificar la dirección URL de inicio de sesión ajustado para la instancia, tenga en cuenta los ejemplos siguientes:

Es un usuario que accede a la instancia de producción de EE.UU. Normalmente, solo debe iniciar sesión en https://sm1.saas.ca.com. Para acceder al archivo WSDL de la solicitud de servicio, se puede acceder a una de las siguientes direcciones URL:
- https://sm1.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl
Es un usuario que accede a la instancia de almacenamiento provisional de EE.UU. Normalmente, se debe iniciar sesión en https://sm1s.saas.ca.com. Para acceder al archivo WSDL de la solicitud de servicio, se puede acceder a una de las siguientes direcciones URL:
- https://sm1s.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1s.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl

Nota: La dirección URL exacta depende de la instancia a la cual accede. Póngase en contacto con el equipo de soporte para la dirección URL exacta o utilice el ejemplo anterior para construir la dirección URL.

Cada vez que se lance una versión más nueva de servicios Web, utilice los siguientes pasos para volver a generar rápidamente el código de cliente de un documento WSDL existente:

Vuelva a generar los códigos auxiliares de cliente mediante la utilidad WSDL2JAVA.

Actualice la clase de cliente desde la versión existente/más reciente del documento WSDL.
Compile y ejecute la clase de cliente.

Compatibilidad con versiones anteriores

ServiceAide Cloud Service Management no garantiza que una aplicación escrita en a una versión de la API de servicios web funcione con las versiones futuras de la API. A menudo, se requieren cambios en firmas de método y representaciones de datos dado que continuamos mejorando la API.

Sin embargo, nos esforzamos por mantener coherente la API con las versiones anteriores. Este enfoque ayuda a garantizar que se pueden transferir aplicaciones a las versiones más recientes de la API haciendo cambios mínimos.