O objetivo deste documento é descrever em alto nível como deve ser o procediemnto de uso do WebService do WebSuite.Esse documento usa o JSON e REST como padrão de integração, pode-se usar outros modelos suportadso como XML, bastando fazer a tradução da chamada em XML.
Para acessar todas os serviços disponíveis no WebSuite deve-se acessar o caminho da url do servidor do WebSuite “http://nome_do_servidor/api/” e será exibida uma tela com todos os recursos do WebSuite e suas descrições
O caminho do WebService é deteminado pelo endereço da URL de chamado. Quando deseja-se que seja feita uma chamada no WebService o endereço e posfixado com “/api/” mais o caminho. Supondo que o endereço do WebService seja http://inventsoftware.info/ e se deseja fazer uma chamada de consulta de parceiro o endereço do webservice será : GET http://inventsoftware.info/api/partner.json e o resultado esperado é um lista de parceiros. Lembre-se que será retornando de acordo com uma paginação, por exemplo, se não for passado os parametros de paginação ( pageNumber, rowNumber e etc ) o WebSuite irá assumir os valores padrões e retornar 100 registros e o número de páginas encontradas.
Todo retorno de um webservice que apresentar algum tipo exceções ou problema, por exemplo erro 400, pode-se consultar os detalhes do retorno em na propriedade de Retorno “responseStatus” veja abaixo :
SalesOne"responseStatus": {
"errorCode": "String",//Codigo
"errors": [ //Lista de Erros
{
"errorCode": "String",
"fieldName": "String",
"message": "String"
}
],
"message": "String",
"stackTrace": "String"
},
O WebSuite usa o padrão REST, isso siginifica que o mesmo usa os status HTTP para tratar resultado de requisições, a lista de status pode ser facilmente encontrado na internet, vamos citar um exemplo: Quanto o stataus for 401 siginifica que o acesso não foi autorizado, 404 siginifica que o recurso (URL) não existe e assim por diante.
Tabela de Serviços :