Skip to content

Access via HTTP

The microservices are accessible via HTTP. Available endpoints and their documentation can be found in the corresponding swagger-ui. The swagger-UI also provides tools to try the endpoints out. You can navigate to the swagger-UI via the links of the APIs in the dashboard.

Instructions (for python)

To access the microservice you first have to create a dictionary that contains all the necessary properties defined in the openAPI (see e.g. swagger-ui).

Now you can create a POST-request. In python the requests.post method is available for this purpose. You need to set two parameters. The database-url (including the endpoint), the request-body payload (which needs to be a string, conversion can be done using json.dumps). Additionally, some extra information about the request should be provided via the headers parameter.

The requests.post methods returns the HTTP-response. It´s content can easily be converted to a dictionary using json.load.

Example to access config-DB (in python)

dict = {"name":"rk1"}
headers = {'content-type': 'application/json', 'accept': 'application/json'}
response = requests.post(DB_API_URL + "/runkey/get", data=json.dumps(dict ), headers=headers)
response_dict = json.loads(response.content)

Using curl

You can also make requests directly from the command line using curl:

curl -X POST "https://$(DB_API_URL)/runkey/get" -H  "accept: application/json" -H  "Content-Type: application/json" -d "{\"name\":\"rk1\"}"

For more examples see the code generated by Swagger-UI (even directly in gitlab).