Skip to main content

Getting Started

First steps​

Our onshore API is your always‑available gateway to the data that drives your operations. Built on industry‑standard technology, it offers a clean and dependable interface—ready for integration by you or any trusted third‑party partner.

Create an account and API keys​

To use any of our APIs, you need a user account for our Fleet Connect portal. If you do not have an account yet, please contact the user group administrator within your organization.

As a user group administrator, you can invite colleagues or third-party staff to Fleet Connect:

  • After logging in, open the “burger menu” in the top right corner and select User Groups.
  • Select the user group, click Invite, and enter the email address of the person you want to invite.

If no user group administrator is available, please contact Hoppe Support at

moc.eniram-eppoh@snoitulosatad. Please provide proof of identity and request a new account. Once the account has been created, an invitation email with a one-time password will be sent.
PREREQUISITES TO ACCESS DATA

To access data via our APIs, you need a valid API key. Each API key is linked to your user account and grants access to all vessels visible to you in Fleet Connect.

  • Ensure that an API key is assigned to your user account.
  • Your ship access depends on your user groups. You can review them by opening the “burger menu” and selecting My Account.
  • User group administrators can add you to additional groups.
  • If your user group lacks access to a specific ship, please contact moc.eniram-eppoh@snoitulosatad
User group administrators

As an administrator, you can manage ship access for your organization, invite additional users, and create subgroups for more granular permission control. For more details, see User Management

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

Creation of API keys​

In the Fleet Connect portal, open the “burger menu” in the top right corner and select Manage API Keys. A small window will appear where you can create or deactivate API keys. To generate a new key, click New API Key and provide a short description. We recommend using meaningful descriptions to easily identify keys later.

caution

The API key is shown only once, immediately after creation. After closing this window, the key value cannot be retrieved again. Please store the key securely.

Treat every API key as confidential and never share it with unauthorized persons. API keys grant access to your sensitive data.

Each API request must include a valid API key in the Authorization header: Authorization: ApiKey <API KEY VALUE>

Support​

The Hoppe Marine Data Solutions Team is happy to support you in developing custom solutions and improving your data analysis capabilities. You can reach us at moc.eniram-eppoh@snoitulosatad.

The API documentation is available here.