Skip to content

Latest commit

 

History

History
130 lines (100 loc) · 6.78 KB

README.md

File metadata and controls

130 lines (100 loc) · 6.78 KB
Raw

Breeding Management System API

BMS API is a set of RESTful web services that allow access to data in the BMS database.

Useful resources

Suscribe (!)

If you plan to use BMSAPI in your dev project, please sign up here for updates: https://forms.gle/DezGg3K3iQ56fRsG6

Authentication

All BMS API calls require authentication and valid access token provided. Please refer to the public Wiki documentation: BMSAPI - Authentication for details.

In exchange of valid users credentials (Workbench user name and password) BMS API issues a fixed time window (configurable per deployment) token which is then required to be provided for each and every BMS API service invocation as part of Authorization key in the request header Authenticate with credentials of a registered Workbench user: Call POST /bmsapi/brapi/v1/token/

{
Request 
POST /bmsapi/brapi/v1/token/ HTTP/1.1 Host: 34.231.120.172:48080 
Content-Type: application/json Cache-Control: no-cache 
{ "username": "username", 
  "password": "user_password", 
  "grant_type": "password", 
  "client_id": "" 
} 
Response
{
   "metadata":{
      "pagination":null,
      "status":null,
      "datafiles":[

      ]
   },
   "userDisplayName":"username",
   "access_token":"username:1522184720103:1c9293bcf819a05309c82d769d51b59f",
   "expires_in":1522184720103
}
}

From now on the token must be included in the header of all further calls to the system to allow verification. Unfortunately there is a discrepancy in the type of authorization header needed for BrAPI and non-BrAPI standard calls:

Header (for BrAPI Standarized calls):

GET /bmsapi/v1/crops HTTP/1.1 
Host: xx.xx.xx.xx:48080 
Authorization: bearer:username:1522184720103:1c9293bcf819a05309c82d769d51b59f 
Cache-Control: no-cache

Header for non BrAPI BMSAPI calls:

GET /bmsapi/v1/crops HTTP/1.1 
Host: xx.xx.xx.xx:48080 
X-Auth-Token: username:1522184720103:1c9293bcf819a05309c82d769d51b59f 
Cache-Control: no-cache

Note that these headers are discrepant in both the name and value of the authentication header.

Additionaly there are some nomenclature differences in BrAPI that must be noted when refering to studies entities. The mapping between the BrAPI entity names and the BMS equivalent is offered below:

BrAPI BMS
Trial Study
Study Instance

Using the BMSAPI Swagger UI

BMSAPI ships with a user interface that allows easy exploration and interaction with various API resources/entities and operations that are exposed. It can be accessed at following URL in any BMS v4.x deployment: http://<server.host>:<server.port>/bmsapi/. This user interface also acts as live documentation of the API resources, methods, and parameters etc. It is built using Swagger which is a standard in REST API live documentation.

Like in the case of direct access (e.g. the cURL examples in previous section) access to BMSAPI methods using this Swagger UI requires the user to first authenticate by logging into the BMS deployed on the same server and in the same browser window/tab.

If you access the Swagger UI without login, an alert message will be shown saying that the authentication has expired. Upon "OK"ing this alert message you will notice that you can still see the API listings and "Try it out!" button etc. under each resource, but upon invoking any API method by clocking the "Try it out!" button, authentication error response will be returned which looks like:

{
  "timestamp": 1459727366021,
  "status": 401,
  "error": "Unauthorized",
  "message": "Access Denied"
}

So, go to the usual BMS login page of the same server deployment at http://<server.host>:<server.port>/ibpworkbench/controller/auth/login/ in the same browser window/tab and login as a valid BMS user first. Once successfully logged into BMS, reload the Swagger UI home page http://<server.host>:<server.port>/bmsapi/ in the same browser window (different tab is fine, but must be same browser window). You should then no longer see the alert message regarding authentication. The Swagger UI now detects that you are authenticated on same server as a valid user. Now invoking the API methods using the "Try it out!" button, you should expect to see appropriate data response.

For Code Contributing Developers

Setup, build from source, install and deploy.

Pre Requisites

See BMS Manual setup

Setup

  • Get the source code (See Pre Requisites)
  • Create and configure your environment specific folder under BMSConfig folder and set values as per your environment such as for MySQL database parameters, tomcat server port etc.
  • The main properties that BMSAPI rely on can be seen in src/main/resources/application.properties and in Middleware project at src/main/resources/database.properties. The values are substituted by Maven build from your environment specific configuration folder in BMSConfig.
  • First run mvn clean install on Middleware.
  • Then run mvn clean install on BMSAPI.

Building and running from source

In standalone mode, application uses the embeded Tomcat from Spring-Boot and automatically deploys to it.

  • At the root of the checkout directory run mvn clean install -DenvConfig={yourConfigFolderName}.
  • This will create bmsapi.war under Maven target folder.
  • Note that this is an executable war file and can be run using java -jar bmsapi.war command which launches BMS API standlone with embedded tomcat provided by Sprint-Boot.
  • Alternatively, copy bmsapi.war file to the webapps directory of your Tomcat installation, in this case the embedded tomcat will automatically be disabled and BMS API will be deployed as a web application within external Tomcat under context path equal to the name of the war file (without the .war extension) as usual.

Running from within Eclipse

  • Import the BMSAPI Maven project from the checkout.
  • Run mvn clean install via command line on BMSAPI project so that application.properties are set and configured in build folder from your BMSConfig folder.
  • Run org.ibp.Main as a java application.

General Notes

The default database connection parameters BMS API uses are the same as the default BMS MySQL database parameters (localhost, port 43306 with user name root and no password). If you are running BMS API alongside your BMS installation, make sure that BMS is started first (mainly so that the BMS MySQL database is up).