API

Orchestrator

In this section we will explain the api and the corresponding features. For a more detailed or practical view please refere to https://e-m-b-a.github.io/embark/ for the Swagger UI documentation.

Getting Started

1. Login
2. Go to this page [http://localhost:8001/user/] or via the sidebar.
3. Generate an api key

Uploading

The entire process is also shown in pictures down below

1. The uploader can be accessed via [http://localhost:8001/api/uploader]
2. Inside the Headers define "Authorization = 'API key' and inside the body create a field named "file" and as input 'Your File'
3. This upload if successful will return a UUID

Check Status

The status of the analysis can be checked via this url [http://localhost:8001/status_report/'YourUUID'], you will still need to define "Authorization = 'API key'". This returns a link to the report if the report is finished or else a status of the progess as shown down below.