Endpoints do portal de serviços

Localizador de evidência

O portal de serviços deverá disponibilizar este serviço de forma que o backend do localizador de evidências possa entregar a resposta do pedido de evidência assim que estiver disponível.

Endpoint: definido pelo portal de serviços durante o processo de integração

Campo	Descrição	Observações
requestId	Identificador do pedido de evidência	Identificador único que servirá para identificar o processo do pedido de evidência. É o mesmo que foi utilizado no URL de redirecionamento como “request-id”.
relatesTo	Identificador da evidência	Identificador único que servirá para identificar um ou mais pedidos de evidência dentro do processo.
evidenceContent	Conteúdo da evidência em base64
evidenceContentType	Tipo de conteúdo da evidência	application/pdf text/xml
evidenceTransformation	Conteúdo do XSLT em base64 utilizado para a transformação de conteúdos XML em HTML	Opcional (obrigatório para content type ‘text/xml’)
evidenceName	Nome da evidência	Opcional
statusCode	Código do estado (pode ser sucesso ou erro)	Ver lista de códigos na secção 2
statusName	No caso de ser erro, este campo inclui a mensagem com o detalhe do erro.

Exemplo do pedido JSON

{
 "requestId": "bf08b6db-3edd-47c3-b48b-b9ae5f3eae92",
 "relatesTo": "45656-1234-ddfg-1234",
 "evidenceContent": "(base64)",
 "evidenceContentType": "application/pdf",
 "evidenceTransformation": "(base64)",
 "statusCode": "SUC_API_001"
}

Parâmetros da resposta (a enviar)

Campo	Descrição	Observações
relatesTo	Identificador da evidência	Mesmo que o enviado no pedido para efeitos de log
operationStatus	Estado da execução da operação
+ success	Se a operação foi efetuada com sucesso	Valor booleano “true” ou “false”
+ code	Código do estado da operação	Verificar lista de códigos disponíveis
+ message	Mensagem relativa à operação efetuada	No caso de a operação não ter sido efetuada com sucesso, este campo é preenchido com a descrição da anomalia ocorrida.

Exemplo da resposta JSON

{
"relatesTo": "45656-1234-ddfg-1234",
"operationStatus": {
"success": true,
"code": "SUC_API_001",
"message:": null
}