# 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                                                         | <p>Identificador único que servirá para identificar um ou mais pedidos de evidência dentro do                                                                 |
| <br>processo.</p>      |                                                                                    |                                                                                                                                                               |
| evidenceContent        | Conteúdo da evidência em base64                                                    |                                                                                                                                                               |
| evidenceContentType    | Tipo de conteúdo da evidência                                                      | <p>application/pdf </p><p>text/xml</p>                                                                                                                        |
| 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**

<pre class="language-json"><code class="lang-json">{
 "requestId": "bf08b6db-3edd-47c3-b48b-b9ae5f3eae92",
 "relatesTo": "45656-1234-ddfg-1234",
 "evidenceContent": "(base64)",
<strong> "evidenceContentType": "application/pdf",
</strong> "evidenceTransformation": "(base64)",
 "statusCode": "SUC_API_001"
}
</code></pre>

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 | <p>Valor booleano “true” ou                                                                                                 |
| <br>“false”</p> |                                        |                                                                                                                             |
| + 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&#xD; anomalia ocorrida. |

Exemplo da resposta JSON

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guias.mosaico.gov.pt/adesao-ao-fornecedor-de-evidencias-localizador-de-evidencia/comunicacao-com-o-localizador-de-evidencia/endpoints-do-portal-de-servicos.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.