Onboarding

Guides

From your first token to a confirmed ticket — learn how FerryGate works and which integration channel fits your project.

Step 1

Getting started

Two things to do before your first call: create an account and get a token.

1

Create an account

Sign up and set up your organisation. Your account gives you access to the dashboard where credentials and bookings are managed.

Create account
2

Get an access token

Generate an access token from your dashboard and send it as a Bearer token on every request. Keep it secret — never expose it in client-side code.

Authentication details
Step 2

Booking flow overview

A booking moves through a short, predictable sequence. Here is the journey from search to ticket, end to end.

  1. 1

    Search availability

    Ask for sailings between two ports on a given date for your passengers and vehicles. You get back the available departures with live prices.

  2. 2

    Take an option

    Hold the chosen sailing for a short window while the traveller confirms their details. The seats and the price are reserved for you.

  3. 3

    Confirm the booking

    Turn the option into a firm reservation. Once confirmed, the booking is paid for and the carrier issues the travel documents.

  4. 4

    Retrieve the ticket and PDF

    Fetch the ticket to get its status, reference number and downloadable PDF voucher to hand to the traveller.

  5. 5

    Cancel when needed

    Cancel a booking subject to the carrier rules. Any applicable refund is handled automatically based on the cancellation policy.

Step 3

Integration channels

Choose how you want to plug FerryGate into your product.