DecisionServerRS

A API DecisionServerRS é uma API REST que estabelece o interface entre sorters e o Servidor de Decisões dos CTT. Esta foi desenvolvida com recurso a produtos de integração seguros e robustos que asseguram uma comunicação transparente entre ambientes produtivos com sistemas e tecnologias heterogênias.

Este interface tem como objetivo possibilitar a pesquisa de destinos possíveis no servidor de decisões referentes à divisão de objetos, assim como notificar a correta classificação de objetos em tempo real.

Através da presente API é possível realizar as seguintes operações:

• Consulta de destinos possíveis obtidos do servidor de decisões;
• Notificar a classificação de objetos;
• Ping de serviço;
• Abertura/fecho de UATs;
• Associação de um objecto a uma UAT em real-time;
• Pedido de movimento de um objecto para posição de saída;

A definição destas operações expostas nos interfaces seguem a norma RESTful e um modelo de comunicação síncrono, o que exige a necessidade de manter a comunicação entre a realização dos pedidos e obtenção das respostas.

Especificação de modelos

A definição das entidades e modelos definidos está disponível em Swagger de acordo com a especificação OpenAPI versão 2.0.

Modelos de Input

Exemplo ClassificationInfo:

{
	"pic": "6849",
	"parcelCodes": [
		{
			"barcode": "UD817750977NL",
			"x": 0,
			"y": 0,
			"z": 0
		}
	],
	"parcelCodesSize": 1,
	"objectMeasurements": {
		"length": "285",
		"height": "65",
		"width": "350",
		"volume": "6483750",
		"weight": "260"
	},
	"sortingMachineID": "TAX_MACHINE",
	"sortingPlanID": "1",
	"sortingEntryType": "Manual",
	"sortingEntryID": "2"
}

Exemplo DestinationNotification:

{
	"pic": "6804",
	"parcelCode": "LX206767326US",
	"sortingMachineID": "TAX_MACHINE",
	"sortingPlanID": "1",
	"sortingExitID": "7",
	"reason": "1+4",
	"sortingType": "Online",
	"sortingDateTime": "20210804115120",
	"containerID": "72021000678"
}

Exemplo OpenCloseRequest:

{
	"destinationCode": "17",
	"containerID": "72021000673",
	"state": "0",
	"parcelCodes": [
		"UD777331895NL",
		"UD535388624LT",
		"UC480028139TW",
		"LT884634404NL"
	]
}

Exemplo SortingInfo:

{
	"sortingPlanID": "1",
	"sortingRuleID": "14",
	"timestamp": "20210804122039"
}

Modelos de Output

{
	"pic": "6849",
	"parcelCode": "UD817750977NL",
	"reason": "1+14",
	"sortingPlanID": "1",
	"sortingRuleID": "14",
	"sortingRuleDesc": "ICS2 Pendente 1 NI",
	"destinations": [
		"13"
	]
}

{
	"receptionStatusCode": 2,
	"receptionStatusMessage": "Action was successfully received"
}

Interfaces Disponíveis

A tabela abaixo descreve os interfaces disponibilizados pela API para as operações referidas anteriomente na secção introdutória:

Informação Pedido/Resposta

Construção de endpoints

Os interfaces disponibilizados pela API são geralmente compostos por sete partes distintas como ilustrado na tabela abaixo.

https://api.qa.ctt.pt/qualidade-01/internal/decisionserverrs/v1/decisionservice/destination/search

Projetos de Teste

A configuração do ambiente para a realização de pedidos aos diferentes serviços disponibilizados pela API requer a utilização de software para testes automáticos (automated testing) como SoapUI ou Postman. Em alternativa, poderão também ser utilizadas ferramentas de linha de comandos como o cURL ou qualquer outra ferramenta de transferência de dados compatível com o protocolo HTTP.

Para efeitos de teste, disponibiliza-se o seguinte projeto de SoapUI:

Projeto de testes - Ambiente de (QUA)

Execução dos testes

O primeiro passo será realizar a importação do projeto de testes através do menu File:

File → Import Project

De seguida surgirá uma janela para carregar o projeto de testes disponibilizado para download no topo desta secção. Em alternativa, também é possível realizar a importação do projeto através da combinação Ctrl+I.

A expansão dos diferentes resources após a importação do projeto, permitirá visualizar a listagem dos diferentes casos de teste para cada interface. Cada interface poderá ter disponível um ou mais casos de teste distintos.

Para executar um teste a um determinado interface basta escolher o caso de teste pretendido:

A execução do teste é realizado através do apontador verde assinalado na figura seguinte:

A informação recebida é obtida no painel "JSON" assinalado do lado direito da figura.

O resultado global de sucesso da transação pode ser aferido pelo conteúdo dos seguintes headers devolvidos na resposta:

1. X-Original-HTTP-Status-Code (200)
2. x-iib-StatusCode (X0)
3. x-iib-StatusMessage (Success)
4. #status# (HTTP/1.0 200 OK)

Entre os restantes headers devolvidos na resposta, destaca-se também o header x-iib-TransactionID. O valor deste header representa um identificador único e universal. Por essa razão identifica de forma unívoca a transação realizada, e pode ser utilizado para efeitos de auditoria ou deteção de anomalias.