Editora Juspodivm - Documentação WebService 2019
Introdução
A ferramenta de webservice da Moovin dispõe de uma plataforma POST para integração com sistemas externos independente da linguagem de programação utilizada.
Os dados da requisição via POST poderão ser enviados em formato JSON ou XML. O formato de retorno será igual ao formato enviado, ou poderá ser definido apenas acrescentando ao final da URL o tipo de formato:
Endereço de web service
O endereço do webservice é constituído da seguinte URL, substitua a sualoja pelo nome da loja e nomeDoMetodo pelo nome do método utilizado no web service.
http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo
Definição do tipo de retorno
O tipo de retorno é definido no endpoint da URL de endereço, os tipos possíveis são json e xml. Exemplos usando os tipos possíveis de retorno:
Retorno usando JSON: http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo/json
Retorno usando XML: http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo/xml
Consultando informações
O webservice dispõe de diversos métodos para consulta de informações. Todos os métodos de resgate de informações suportam o envio de filtros de busca. Na descrição dos métodos abaixo, será listado o nome e os filtros que cada um suporta.
Estrutura de filtros
A estrutura de filtros de cada método varia de acordo com o tipo de dados enviado para a requisição, os tipos possíveis são json e xml, segue exemplos de como aplicar o filtro em cada um dos tipos:
Filtro usando JSON:
{
filtro1: "valor",
filtro2: "valor"
}Filtro usando XML:
<filtros>
<filtro1>valor</filtro1>
<filtro2>valor</filtro2>
</filtros>
Enviando informações
O webservice dispõe de métodos para o envio de informações de cadastros. Como retorno, virá um código de erro e uma mensagem. Em caso de sucesso, o código de erro é 0 (zero) e a mensagem “sucesso”. No final deste manual, encontra-se uma tabela com os possíveis retornas e seus respectivos códigos, mensagem e descrição.
Estrutura de retornos
A estrutura de retorno varia de acordo com o tipo definido para o retorno, segue exemplos de como os retornos são de acordo com o tipo:
Retorno usando JSON:
{
error: "codigo",
message: "Mensagem de retorno"
}
Retorno usando XML:
Descrição dos métodos
Para utilizar todos os métodos do webservice é necessário preencher dois parâmetros no POST da requisição, o primeiro é o token e o segundo é o data, o token é uma string com o token do cliente, já o data é um JSON ou XML contendo o filtro ou dados da requisição, filtros são usados em métodos gets e dados são usados em métodos save ou update.
Cada método é separado em três tópicos: método, descrição e filtro ou dados (dependendo do tipo de método get, save ou update). Alguns métodos ainda possuem exemplos de dados para fazer uma requisição em JSON e XML.
Métodos GET
Métodos SAVE
Métodos UPDATE
Tabela de retornos
O webservice retorna na requisição duas informações o código e a mensagem, para facilitar a compreensão, nós disponibilizamos uma tabela contendo o código, mensagem e descrição:
Código | Mensagem | Descrição |
0 | Sucesso | Operação foi realizada com sucesso |
1 | Dados não enviados ou em formato desconhecido | Os dados não foram enviados em um formato compatível. Verifique se os dados estão em XML ou JSON |
2 | Método inexistente | O método requisitado não existe, verifique a documentação para ver os métodos válidos |
3 | Nenhum resultado encontrado para a busca | Ocorre quando não é encontrado nenhum resultado na consulta |
4 | Token não enviado ou incorreto | Verifique se o token foi enviado corretamente e se o mesmo está correto. |
5 | Não foi possível identificar a requisição | A requisição não veio por POST nem por SOAP. |
6 | Ocorreu um erro interno ao carregar o webservice | Entre em contato conosco informando esse erro |
7 | Verifique se os dados foram enviados corretamente | Faltam dados ou foram enviados em formato incorreto |
8 | Data não enviada ou em formato incorreto | Verifique a data enviada se está no formato conforme descreve a documentação |
9 | Verifique se os dados dos produtos foram enviados corretamente | Consulte esta documentação para maiores informações de como enviar os dados dos produtos |