Introdução à API de serviços web

Esta seção fornece as informações necessárias para acessar e usar a WS API (Web Services API - API de Serviços Web). A WS API atualmente oferece suporte ao protocolo SOAP.

Essa API fornece uma maneira programática de interagir com a plataforma da central de atendimento. É possível alterar os dados de entidades, como Tickets, Itens de configuração e Artigos de conhecimento que são gerenciados no aplicativo da central de atendimento.

Para usar esse documento, é necessário ter uma familiaridade básica com o desenvolvimento de software, serviços web e a interface de usuário do Service Desk. Qualquer funcionalidade descrita nesse documento só estará disponível se a sua organização tiver uma licença de acesso aos Serviços web.

Se não puder acessar os recursos exibidos nesse documento, entre em contato com o suporte da Central de atendimento.

Observação: recomendamos usar o cliente de UI SOAP para fazer interface com os serviços web do ServiceAide Cloud Service Management. Consulte o site http://www.soapui.org para obter mais informações sobre como usar o cliente de UI SOAP.

Esta seção contém os seguintes tópicos:

Conformidade com os padrões

A API WS é implementada para conformidade com as seguintes especificações padrão:

Nome padrão	Site
Protocolo de acesso a objeto simples (SOAP) 1.1	http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
Web Service Description Language (WSDL) 1.1	http://www.w3.org/TR/2001/NOTE-wsdl-20010315

Plataformas de desenvolvimento

A API foi validada para funcionar com os ambientes de desenvolvimento J2EE 1.6 e o Apache Axis2. Neste documento, fornecemos exemplos em Java. Esses exemplos são baseadas no Apache Axis2 1.5.1 e no JDK 1.6. Para obter mais informações, consulte http://axis.apache.org/axis2/java/core/.

Diretiva de suporte à API

Recomendamos que os seus novos aplicativos cliente usem a versão mais recente do arquivo WSDL da Central de atendimento para aproveitar totalmente os benefícios oferecidos pelos recursos mais aprimorados e pela maior eficiência. Você pode buscar a WSDL mais recente acessando o URL de serviços web do Service Desk.

Por exemplo, você pode obter a WSDL de solicitação de serviço indo para este URL- https:// {servicedeskcontexturl} /NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl. Nesse exemplo, o {servicedeskcontexturl} é o URL de logon ajustado. Para identificar o URL de logon ajustado para sua instância, considere estes exemplos:

Você é um usuário que acessa a instância de produção dos EUA. Em geral, você efetua logon no https://sm1.saas.ca.com. Para acessar a WSDL de solicitação de serviço, você pode acessar um dos seguintes URLs:
- https://sm1.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl
Você é um usuário que acessa a instância de testes dos EUA. Em geral, você efetua logon no https://sm1s.saas.ca.com. Para acessar a WSDL de solicitação de serviço, você pode acessar um dos seguintes URLs:
- https://sm1s.saas.ca.com/NimsoftServiceDesk/servicedesk/webservices/ServiceRequest?wsdl
- https://sm1s.saas.ca.com/servicedesk/webservices/ServiceRequest?wsdl

Observação: o URL exato depende da instância que você está acessando. Entre em contato com a equipe de suporte do URL exato ou use o exemplo acima para criar o URL.

Cada vez que uma release mais recente dos Serviços web for liberada, siga essas etapas para gerar novamente o código de cliente a partir de um documento WSDL existente:

Gerar novamente os stubs do cliente usando o utilitário WSDL2JAVA.

Atualizar a classe do cliente a partir da versão existente/mais recente do documento WSDL.
Compilar e executar a classe do cliente.

Compatibilidade com versões anteriores

O ServiceAide Cloud Service Management não garante que um aplicativo criado em uma versão da API WS funcionará nas futuras versões da API. Alterações nas assinaturas de método e representações de dados geralmente são necessárias à medida que aprimoramos a API.

No entanto, nos esforçamos para manter a API consistente com versões anteriores. Essa abordagem ajuda a garantir que você possa transportar aplicativos para versões mais recentes da API com o mínimo de alterações.