REGARDS services overview

How to access API endpoints

Access microservices directly

You can access each REGARDS API endpoint thanks to a Curl request.

You can request without authentication by adding the REGARDS project in the request thanks to the parameter scope

curl http://localhost:<microservice port>/<endpoint>?scope=<project>

Or you can authenticate to access admin endpoints first. To do so, use the authentication API to get a verified REGARDS token and then add the token to the request headers.

curl http://localhost:<microservice port>/<endpoint> -H 'Authorization: bearer <token>'

Access from outside

To access endpoints from outside the microservice installation server, you need to use the "gateway" microservice. To do so, use the here under access point instead of the previous one.

curl http://<gateway host>:<gateway port>/<microservice>/api/v1/<endpoint>

Alternatively, you can access endpoints from outside through the "gateway" microservice using an external Oauth2 token direclty (one that was not generated by REGARDS).

To do so, you must first authenticate through a configured "Service Provider" authentication plugin, see the authentication plugins page.

Once you have successfully authenticated and retrieved an external Oauth2 token, you can use it against the "gateway" microservice which will verify its validity and allow the request to reach its destination inside the REGARDS microservices using a hidden, internal REGARDS token.

curl http://<gateway host>:<gateway port>/<microservice>/api/v1/<endpoint> -H 'Authorization: bearer <sso token>'