API - Status da entrega da regra
Manual da API de status da entrega da regra - versão 2 - 05/06/2020
O que é?
API REST em formato JSON que permite a identificação do momento em que se encontra uma regra no processo de produção.
Informações estruturais
URL de acesso, dados da chamada, dados de retorno, etc.
Informações estruturais
URL de acesso
A URL de acesso da API é a seguinte:
http://app.systax.com.br/api/validaEntrega
Informações estruturais
Autenticação
Para utilizar esse recurso é necessário passar, no header da requisição um token. Esse token é obtidito através da API Auth Token.
Informações estruturais
Dados da chamada
Dados da chamada
{
"id_cliente": "00000",
"cod_interno": "codigo produto",
"origem_produto": "0",
"id_cenario": "111111"
}
Significado dos campos da chamada
- id_cliente - Código interno do cliente cadastrado na Systax
- cod_interno - Código do produto cadastrado
- origem_produto - Origem da mercadoria
- id_cenario - Código do cenário, disponibilizado através das API's de consulta de regras ou do Cockpit
Informações estruturais
Dados do retorno
Dados do retorno
{
"code": 200,
"msg": "A regra está pronta pra entrega"
}
Significado dos campos do retorno
- code - Código único que representa o status de produção da regra.
- msg - Texto descrevendo a mensagem
Códigos de retorno
- 130 - Regra não encontrada. Aguardando produção.
- 131 - A regra está no relatório de processamento (controle de qualidade)
- 132 - A regra foi rejeitada no controle de qualidade
- 133 - A regra foi aprovada pelo controle de qualidade, aguardando processamento da regra
- 117 - Cenário não relacionado a cenário da Base Systax
- 200 - A regra está pronta pra entrega