REST API

Sovelluksella on kaksi porttia. Ulkoinen portti määritellään asetuksella server.port Sisäinen portti määritellään asetuksella server.internal.port

Sisäiset rajapinnat määritellään @InternalRestController annotationilla ja niiden polkuun lisätään automaattisesti api.rest.pathPrefix asetuksessa oleva prefix. Sisäiset RestController luokkien ja polkujen tulee olla versioituna.

Ulkoiset rajapinnat ovat:

/integration/rest/{code}/**

Tähän tulevat pyynnöt ohjataan sisäisiin rajapintoihin.

Pyynnössä tulee api-avain (JWT muotoinen) API-Key headerissä;

/integration/run-report/{code}/{reportKey}/{templateKey}

Tähän tulevat pyynnöt ohjataan Pepin raporttipalveluun.

Pyynnössä tulee api-avain (JWT muotoinen) API-Key headerissä;

/integration/opensearch/{code}/{index}/_search Tähän tulevat pyynnöt ohjataan suoraan Opensearchiin. Pyynnössä tulevat URL parametrit välitetään Opensearchille.

Pyynnössä tulee api-avain (JWT muotoinen) API-Key headerissä;

OpenAPI

Open API löytyy erillisen palvelimen URL:sta /v3/api-docs.

Swagger

Swagger UI löytyy erillisen palvelimen URL:sta /swagger-ui/index.html.