Create an IAMconnected organization account for your organization. You can find the process here: Getting started with Portbase – Portbase
After successful registration: Log in with your IAMconnected account on Portbase.com
Request the Vessel Visit API via: https://www.portbase.com/en/services/vessel-visit-api/
Sign the contract by an authorized representative of your organization.
– After having completed this step you will receive an email from our Integration Specialists with the provided keys, API documentation and further instructions.
Instructions for testing the API
You can use the provided test keys to connect to the Tracking API, the API that contains real-time vessel visit updates.
Click here for the API documentation
Please note! For testing the API, we configured things in such a way that your organization has been authorized by Cross-Ocean. This means that your organization will receive the vessel visit updates from Cross-Ocean once you are connected to the API.
In production environment, it will be necessary to explicitly request data authorization from the data owner(s) via MyData: the application where data sharing permissions (authorizations) between data owners and data users can be managed.
After successfully testing the API, you can proceed to production.
Instructions for using the API in production
Step 1. Connect to the Tracking API
You can use the provided production keys to connect to the Tracking API: the API that contains real-time vessel visit updates. You can find the technical documentation here.
Step 2. Notify Portbase after successful connection
Send an email to service.request@portbase.com that you successfully connected, so that Portbase can send you an invitation to Vessel Visit in the MyData application.
Log in with IAMconnected and make sure that you have the Data Manager role, so that the MyData tile is accessible.
You can request the Data Manager role as follows:
1. Log in to IAMconnected
2. Go to Profile, and then to Business Information
3. Click on Change and select the Data Manager role
4. After approval by the Main Administrator of your organization in IAMconnected, the data manager role is active.
Go to “MyData” and accept the invitation to the Vessel Visit
Log in with IAMconnected -> Select MyData -> Select the tab MyDashboard -> Data User view -> Data Service -> Vessel Visit -> Data Access -> and accept the invitation.
Request permission from the data owners
After permission from the data owner(s), you can actually receive the vessel visit updates from the data owner(s) via the API.
Click here for the more detailed MyData manual for data users (Slide 3-6 are not applicable for Vessel Visit)