API Processar da Portaria de Entrada

Objetivo

Fazer o processamento da Portaria de Entrada de uma determinada OC, caso o depósito esteja configurado para trabalhar com automação Zylix. Para mais informações, ver Zylix - Integração com Polysoftware

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 Documentação - API Obtenção de Token

2. Processamento da portaria de entrada de Ordem de Carregamento

Introdução

Este webservice tem por finalidade o processamento de uma OC já na fila na portaria de entrada conforme seu número e empresa do token obtido em passo anterior. Ele realiza todo o processamento da portaria de entrada passando a OC para a portaria de saída.

Esta API está protegida por um perfil de usuário Pode Incluir carregamento Manual. Para mais informações, ver Painel Carregamento (Usuários)

Endereço

<endereço do SispetroWeb>/ordem_carregamento/processa_portaria_entrada_via_api

Parâmetros

Será necessário enviar um header com o token e no corpo do webservice o número da ordem de carregamento que se deseja cancelar.

Headers

Nome	Descritivo	Exemplo	Observações

Nome	Descritivo	Exemplo
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

Body

Layout abaixo em formato JSON.

Item	Chave	Conteudo	Pai	Obrigatório

Item	Chave	Conteudo	Pai	Obrigatório
1	id	Número da OC no Sispetro	-	Sim

Método

POST

Exemplo de chamada de WebService

curl -H "Content-Type: application/json" -H "Accept: application/json" -X POST -H "Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZF91c3VhcmlvIjozMiwiY25waiI6IjAxLjgwNC4zNDUvMDAwMS02MCIsImV4cCI6MTUwMDA1MzYxN30.-ZvhWFYI8fyx66b3kZY1UVUrfaWUTioV3_M6K2wiPGM" http://localhost/ordem_carregamento/processamento_portaria_entrada_via_api -d '{"id":"8383"}'

Retorno Bem Sucedido

Será retornado um objeto JSON com uma mensagem fixa e o status 200. O status da resposta sempre será 200.

{"resultado": "ordem carregamento processada com sucesso","status":200}

Retornos Sem Sucesso

Será retornado um objeto JSON com o motivo do não processamento (poderá ser 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.

Exemplos:

A OC já foi processada, consta na Portaria de Saída e a API ser requisitada novamente para mesma OC

{ "errors": { "base": "A ordem de carregamento selecionada já encontra-se na portaria de saída ERRO_OC_JA_PROCESSADA." }, "status": 400 }
A OC não consta no banco de dados

{"error":"OC não encontrada","status":400}
Caso o arquivo de integração da Portaria de Entrada não for encontrado

{ "errors": { "base": "Arquivo de integracao da portaria nao encontrado OC(ID): xxxxx Verifique se o arquivo ja foi gerado." }, "status": 400 }