Manual da API de status do cenário

Manual contendo as últimas atualizações efetuadas em 12/03/2024.

Introdução
Acesso
Autenticação
Definições de pesquisa
Códigos de retorno
Exemplos de chamada e retorno

Introdução

Essa API tem como objetivo informar se cenario está vinculado a base centralizada e caso não esteja identificar possiveis motivos.

Acesso

Comunicação: REST/JSON

Para acessar a coleção de chamadas Clique Aqui.

Swagger Status de Cenário
https://app.systax.com.br/auth/swagger#/cenarios/statusCenario

Listagem do Endpoint que contempla o manual de Status de Cenário

Descrição	Grupo Swagger	Método	URL Endpoint	URL Token
Listar status do cenário	Cenarios	Get	http://app.systax.com.br/cadastro-geral/cenarios/status/{}	https://app.systax.com.br/auth/access-token

Autenticação

A autenticação desta API pode ser feita via bearer token ou basic auth.

Para mais informações sobre como gerá-lo, consultar a última versão do documento através do link: https://documentacao.systax.com.br/PublicView2/Index/b033088a83871008165f222fd/30682

Definições de pesquisa

Objeto de pesquisa	Definição	Obrigatório
id_cenario	deve ser indicador na url	Sim

Códigos de retorno

Código de retorno	Sucess	Message	Motivo	Descrição
100	Ok	cenário vinculado a base centralizada	-	Indica que o cenário consultado está vinculado a Base Centralizada
200	Ok	cenário não vinculado a base centralizada	alternativo_ex_origem não existe	Indica que o cenário não está vinculado, pois o Ex Origem preenchido no cenário não existe
200	Ok	cenário não vinculado a base centralizada	destinação não existe	Indica que o cenário não está vinculado, pois o Destinação preenchido no cenário não existe
200	Ok	cenário não vinculado a base centralizada	natureza não existe	Indica que o cenário não está vinculado, pois a Natureza preenchida não existe
200	Ok	cenário não vinculado a base centralizada	finalidade não existe	Indica que o cenário não está vinculado, pois a Finalidade preenchida não existe
200	Ok	cenário não vinculado a base centralizada	cenário de entrada e não indicado "finalidade"	Indica que o cenário não está vinculado, pois é uma operação de entrada e a Finalidade não foi indicada
200	Ok	cenário não vinculado a base centralizada	grupo cache deve ser "A" (ICMS)	Indica que o cenário não está vinculado, pois o grupo cache é diferente de "A" (ICMS)
200	Ok	cenário não vinculado a base centralizada	outros	Indica que o cenário não está vinculado por outros motivos, que não foram indicados acima
200	Ok	cenário não vinculado a base centralizada	outros	Indica que o cenário não está vinculado por outros motivos, que não foram indicados acima
200	Ok	ID cenário não localizado	deletado	Indica que o cenário foi deletado
400	Bad Request	token_invalid	-	Indica que o token expirou ou está incorreto
400	Bad Request	missing_token	-	Indica que o token não foi preenchido

Exemplos de chamada e retorno

Chamada

http://app.systax.com.br/cadastro-geral/cenarios/status/2506448

Retorno

{
   "status": "200",
   "msg": "Cenário não vinculado a base centraliza",
   "motivo": "Grupo cache deve ser 'A' (ICMS)"
}