Prise en main

Guides

De votre premier token au ticket confirmé : découvrez comment fonctionne FerryGate et quel canal d'intégration convient à votre projet.

Étape 1

Prise en main

Deux choses à faire avant votre premier appel : créer un compte et obtenir un token.

Créer un compte

Inscrivez-vous et configurez votre organisation. Votre compte vous donne accès au tableau de bord où sont gérés les identifiants et les réservations.

Créer un compte

Obtenir un token d'accès

Générez un token d'accès depuis votre tableau de bord et envoyez-le en tant que Bearer token sur chaque requête. Gardez-le secret : ne l'exposez jamais côté client.

Détails de l'authentification

Étape 2

Vue d'ensemble du flux de réservation

Une réservation suit une séquence courte et prévisible. Voici le parcours de la recherche au ticket, de bout en bout.

1
Rechercher la disponibilité
Demandez les traversées entre deux ports à une date donnée pour vos passagers et véhicules. Vous récupérez les départs disponibles avec leurs prix en direct.
2
Poser une option
Bloquez la traversée choisie pendant un court instant le temps que le voyageur confirme ses informations. Les places et le prix vous sont réservés.
3
Confirmer la réservation
Transformez l'option en réservation ferme. Une fois confirmée, la réservation est payée et le transporteur émet les documents de voyage.
4
Récupérer le ticket et le PDF
Récupérez le ticket pour obtenir son statut, son numéro de référence et le bon PDF téléchargeable à remettre au voyageur.
5
Annuler si besoin
Annulez une réservation selon les règles du transporteur. Tout remboursement applicable est traité automatiquement selon la politique d'annulation.

Suivre l'état

Chaque réservation expose un stage (son état agrégé) et un ensemble de possible_actions qui indiquent précisément ce que vous pouvez faire ensuite : payer, émettre, annuler, réessayer ou télécharger. Pilotez votre interface à partir de ces deux champs plutôt qu'à partir des statuts bruts des billets. Consultez la référence de l'API pour la machine à états complète.

Voir la référence API complète

Étape 3