Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

...

...

View file
nameentidade.json

Objetivo

Este webservice tem por finalidade obter os pedidos que foram alterados a partir de uma Data e hora.

Uso Geral

1. Obter token autenticação

Introdução

Qualquer webservice do projeto SispetroWeb exigirá um token de autenticação. Este token é gerado a partir deste webservice e será válido por 24 horas. Assim, recomendamos que o sistema consumidor dos webservices aqui descritos salvem o token armazenando também a data e hora em que ele foi gerado para que, quando chegar próximo de sua validade, seja obtido novo token.

Para mais informações, ver API Obtenção de Token

Métodos do setor de Vendas

2. Pedidos de Venda alterados

Introdução

Este webservice tem por finalidade obter os pedidos a partir de uma Data e hora.

Endereço

<endereço do SispetroWeb>/pedido_venda/pedidos_alterados

Parâmetros

Será necessário enviar um header com o token. Como parâmetros enviar:

...

Nome

Descritivo

Exemplo

Observações

Authorization

Conteúdo do token obtido no passo de autenticação do usuário

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM


Content-Type

tipo do formato de envio

application/json


Accept

tipo do formato de envio

application/json


Método

GET

Exemplo de chamada de WebService
Bloco de código
curl -X GET -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjo4NCwiY25waiI6IjAwLjAwMC4wMDAvMDAwMC0wMSIsImRlcG9zaXRvX3BhZHJhbyI6bnVsbCwiZXhwIjoxNzE3NzY3NDAyfQ.j_CChFzlGOMkfvQ1psP8gaxZiKQ8yiD1pJnyVeUWkg0'
http://localhost/pedidos_alterados\?data_hora_inicial\=2024-01-01%2010:00
Retorno Bem Sucedido

Serão retornados todos os dados relativos aos pedidos alterados a partir da data/hora informada. O status da resposta sempre será 200. 

...

Item

Chave

Conteudo

Pai

1

IDPedido

Código da entidade alterada ou excluída

2

FlagOperacao

I = inclusão, U = alteração ou E = exclusão

3

pedido_venda

mesmo layout de retorno de um pedido https://futura.atlassian.net/wiki/spaces/ESP/pages/4691329025/API+para+Vendas#1.-Inclus%C3%A3o-Pedido-de-Venda

Nota

Se o flagOperação for igual a 'E' (exclusão), não retorna a estrutura pedido_venda.

Retorno Sem Sucesso

Será retornado um objeto JSON com o motivo da falha (normalmente  um erro de autenticação caso o token tenha expirado ou seja inválido ou alguma regra de negócio não atendida. O status da resposta sempre será diferente de 200.

...