Integration Settings
Introduction
Hub features a comprehensive version-controlled RESTful API ("Web API") that is available to all member organisations.
All key Hub functionality is exposed through the Web API.
Web API Access
Access to the Web API must be requested from Hub Technical Support by an Organisation Administrator.
A Web API-enabled User Account will then be created in your Organisation.
The Web API enforces User Roles - ensure you grant the API User the correct roles for the actions your integration will perform.
Authentication
To authenticate with the Web API, a token must be obtained by passing your Web API-enabled User Account credentials to the appropriate token URL:
| Environment | Token URL |
|---|---|
| UAT (User Acceptance Testing) | uat-core-hub-api.misvetting.com/token |
| Production | app-api.marinedatahub.org/token |
A valid request will receive a response in the following format:
{
"access_token": "<TOKEN>",
"token_type": "bearer",
"expires_in": 1199
}The access_token must be sent in the header of all subsequent API requests:
Authorization: Bearer <TOKEN>
Token Expiry
Authentication tokens expire every 1200 seconds (20 minutes).
The seconds remaining until expiry are returned in the expires_in field in the response body. Ensure that your integration refreshes the authentication token before this time elapses.
Base URLs
UAT: uat-core-hub-api.misvetting.com
A full test harness is available for the UAT environment.
Production: app-api.marinedatahub.org
User Accounts are unique to each environment, however you should still ensure that your integration is configured for UAT when testing.