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:



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





Get Características



Método

O nome do método utilizado na consulta é getCaracteristicas.

Descrição

Este método retorna uma listagem com as características cadastradas.

Filtros

Os filtros são organizados em uma tabela contendo o nome, tipo e descrição de cada filtro.

Nome

Tipo

Descrição

limite

Integer(10)

Defini a quantidade de registros a retornar.

codigo

Integer(11)

Busca pelo código da característica que contém.

nome

String(50)

Busca pelo nome da característica que contém.



Retorno

Os retornos são organizados em uma tabela contendo grupo do campo, nome, tipo, e descrição de cada campo.



Grupo

Nome

Tipo

Descrição

raiz

caracteristicas



Campo principal da estrutura.

Todas as características da consulta são retornados dentro dele.

caracteristicas

caracteristica



Contém os dados referentes a uma característica.

caracteristica

codigo

Integer(11)

Identificador da característica na plataforma.

caracteristica

nome

String(50)

Nome da característica.

caracteristica

filtro

Integer(1)

Defini se a característica irá ser utilizada como filtro para o cliente na loja. Retorna:

- 1 “Sim”

- 0 “Não”

caracteristica

multi

Integer(1)

Defini se é permitido ser relacionado mais de uma opção ao produto. Retorna:

- 1 “Sim”

- 0 “Não”

caracteristica

genero

Integer(1)

Gênero da característica. Retorna:

- 0 “Unissex”

- 1 “Masculino”

- 2 “Feminino”

caracteristica

faixa_etaria

Integer(1)

Faixa etária da característica. Retorna:

- 1 “Adulto”

- 2 “Infantil’

caracteristica

exibe_descricao

Integer(1)

Defini se a característica será exibida na descrição do produto. Retorna:

- 1 “Sim”

- 0 “Não”

caracteristica

obrigatorio

Integer(1)

Defini se o campo deve ser preenchido pelo operador ao relacionar com o produto. Retorna:

- 1 “Sim”

- 0 “Não”

caracteristica

slug

String(55)

Identificador amigável da característica.

caracteristica

categorias

Array

Conjunto de categorias da característica.

categorias

categoria



Categoria relacionada ao conjunto de categorias.

categoria

cod_categoria

Integer(11)

Código da categoria.

categoria

nome

String(100)

Nome da categoria.

caracteristica

atributos

Array

Conjunto de atributos da característica.

atributos

atributo



Atributo relacionado ao conjunto de Atributos.

atributo

cod_atributo

Integer(11)

Código do atributo.

atributo

nome

String(50)

Nome do atributo.


Exemplo de retorno XML:



XML - Get Caracteristicas
















































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































<