BioloMICS Web Menu

Web service - new

Full movie BioloMICS Webservice basics (see below).

Clients of BioAware that have the BioloMICS web version are able to request the activation of a webservice for their own database.

Others are then able to connect to the webservice and extract data from, or put data in, your database (depending on the rights).

What they can do is set up by the administrator of the database.

There are 2 sections:

Admin panel, where the data to be exposed are specified (YAML).
UI (User Interface) documentation, where the user can create the endpoints (GET, POST, PUT, PATCH and DEL).

For each webservice, a UI document will be generated.

For more details, see the sections below:

Activate webservice, managed by BioAware
First make sure that the webservice has been activated (by BioAware staff). If not then please contact us through info@bio-aware.com.

Admin panel, managed by SuperAdmin of database
Access the admin section of the webservice
Go to https://webservices.bio-aware.com/ WEBSERVICE_BASE_PATH/admin
Login with the SuperAdmin account of the database.
Now it opens the place where the webservice can be defined (YAML).

This is the mapping, to match between tables and models of the API.

The models are shown in the UI documentation, at the bottom of the left navigation column.

Models are the structures of data used by an endpoint.

Here you specify the data that should be exposed.
webservice:
Enter the sql name of the table(s) (in path) and sql name of the field(s) (in properties).
Ctrl+space gives suggestions of all tables of underlying database and fields of underlying table.
Make sure that all sql names here are written correctly.
For example:
total_price is the sql name of the field.
name is mandatory. This is the name shown in the json (output of API). Use Camel case (first letter lower case and no spaces, like ‘linkToSuggestions’)
displayName (optional) when the sql name is not user friendly enough to be displayed. This name will be shown in the Models section.
description can be added too (optional)
For link fields, create different levels to reach a field in the target table.
Security:
Secret key (clientSecret) can be added if preferred.
If it is added in the mapping then the user MUST use it to authorize.
If no secret key and the data are all internet-user-readable then no login/authorize is needed.
Click on the Save icon (at the top-right) to save the changes.

UI (User Interface) documentation, managed by the user of the webservice
The UI (User Interface) documentation can be reached by going to the following link: https://webservices.bio-aware.com/WEBSERVICE_BASE_PATH/NAMEOF_WEBSERVICE

Here the NAMEOF_WEBSERVICE would be public.
If the data are not public, then a login/authorize is required.
Username: email address of the BioloMICS profile.
Password: password of the BioloMICS profile.
Client ID: as written in the Admin panel (YAML)
Client Secret: if there is a secret key added in the Admin panel (YAML), then it is mandatory here to be able to login/authorize successfully.
Click on the Authorize button.

• If the data are public then the authorization step can be ignored.
In the left navigation column, click on one of the end points, for example the GET.
Details about the GET are shown on the right.

Click on the button Test request.
On the left you see the Request section, and on the right the Response.
Request: to put the different parameters
page: Starting page (number of page)
pageSize: When this is left empty, then it will be defaulted to 100.
More details about all options are explained in the previous step.

Click on the Send button to get the response.
Response: json format
Shows the number of records found.
And its details.
The response can be downloaded (as .json file) by clicking on the download button just above the Body section.
Available tags:
GET: to extract the specified data from the database.
See movie from 2m55s and 4m25s
POST: to enter new data into the database.
See movie from 5m19s
PUT: to update data of the complete record(s) in the database
See movie from 6m32s and 8m19s
PATCH: to partially update record(s) in the database (not all fields of that record but only selected field(s)).
See movie from 10m05s and 11m38s
DELETE: to delete data in the database (for specified record(s) only).
See movie from 12m49s and 13m23s
Postman can also be used to test. This is an independent software that is more advanced than the test runner.
Click on Download OpenAPI Document to export the YAML file (Open API document).
In postman the downloaded YAML file can be imported.