Skip to main content

Getting Started

Create an account and API keys​

To use any of our APIs you must have a user account for our Fleet Connect portal. If you don't have a user account yet, please contact the user group administrator of your organization.

As an user group administrator, you can invite your colleagues or third-party staff via Fleet Connect:

  • After logging in, click on the "burger menu" in the top right corner of the screen and select "User Groups."
  • Choose the appropriate user group, click on the "Invite" button, and enter the email address of the person you wish to invite.

If the user group administrator is not available, contact the Hoppe Support at moc.eniram-eppoh@snoitulosatad prove your identity and request a new account.

Once the account is created, an invitation email with a one-time password to activate the account will be sent out.

PREREQUISITES TO ACCESS DATA

To access data via the APIs, you need a valid API key. The API key provides general access to our APIs and is linked to your user account, allowing access to all ships visible to you in the Fleet Connect portal.

  • Ensure you have a valid API key linked to your user account.
  • Your account's access to ships depends on your user groups. Check your user groups in the portal by clicking on the "burger menu" in the top right corner and selecting "My Account."
  • User group administrators can invite you to additional user groups.
  • If your user group lacks access rights for a ship, please contact moc.eniram-eppoh@snoitulosatad
User group administrators

As an administrator, you can manage access to your ships and invite additional users to Fleet Connect. You can also create subgroups to manage fine-grained control over your ships, see User Management

To obtain administrator rights, reach out to an existing user group administrator within your organization or contact Hoppe Support at moc.eniram-eppoh@snoitulosatad

Creation of API keys​

In Fleet Connect portal, click on the "burger menu" in the top right corner and select "Manage API Keys".

In the Fleet Connect portal, click on the "burger menu" in the top right corner and select "Manage API Keys". This will open a small window with a simple interface for creating and invalidating API keys. To create a new key, click on the "New API Key" button. You will be prompted to give the API key a description. We recommend giving your API keys meaningful descriptions to easily identify them for different purposes later on.

caution

You will only be able to see the API key once, immediately after it has been generated. Once that window has been closed, you will not be able to access the API key's value again. Please make sure to safely store the API key after creation.

Please always treat each API key as secret and do not share it with any unauthorized persons. An API key allows access to some of your most valuable assets: your data.

A valid API key must be provided in the Authorization header as Authorization: ApiKey <API KEY VALUE> for each API request.

First steps with the Ships API​

Our onshore API provides customers worldwide 24/7 access to their data assets. With focus on strong security and state-of-the-art technology, data is provided via an easy-to-use and intuitive interface. This interface follows industry standards allowing for easy access by the customer itself or any third partner which is delegated the permission by the customer to access the data on its behalf. In order to guarantee connection integrity and security all traffic is TLS encrypted. This encryption is enforced server side. Unencrypted connections are denied access.

You can find our API documention here.

Support​

The Hoppe Marine Data Solutions Team is keen to assist you with the development of your custom-made solution to bring your data analysis capabilities to the next level.

You can reach us at moc.eniram-eppoh@snoitulosatad.