Ctrlk
Go to Yoplanning.pro
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Procedure for connecting to the French Sailing Federation (FFV)

This guide explains how to connect Yoplanning to the French Sailing Federation (FFV) to sell, create and control FFV licenses directly from your software.

What is the purpose of the FFV connection?

The connection between Yoplanning and the FFV API allows:

  • To sell FFV licenses online from the booking module.

  • To automatically check if a participant already has a valid license.

  • To display a visual indicator on the sessions.

  • To allow the office (BE) to quickly check the licenses.

  • To create an FFV license in the customer's name after their purchase.

Operating principle

Optional license sale

The FFV license is sold as an option in the booking module.

When a customer buys a license:

  1. The license is added to his order.

  2. An automated FFV email has been sent.

  3. The customer completes their personal information.

  4. Yoplanning then sends the creation request to the FFV via the API.

The license is created with the FFV only after validation of the information by the client.

Verification of existing licenses

Even if the customer does not purchase a license, Yoplanning can query the FFV automatically.

Mandatory condition:

  • Name

  • First name

  • Date of birth

  • Gender

If these 4 pieces of information are present, Yoplanning queries the FFV to retrieve existing licenses.

Procedure on the FFV side

The organization must authorize Yoplanning to act on its behalf.

Official FFV procedure: 👉 https://www.notion.so/ffvoile-dsi/Autoriser-une-solution-externe-agir-au-nom-d-une-structure-2f7ebc4120c880099d31c738169e0a9a

Configuration in Yoplanning

Step 1: Request activation of the FFV module

To obtain the FFV module setup:

  1. Contact Yoplanning support (support@yoplanning.com) to request activation of the FFV module.

  2. Provide your FFV structure ID.

Our Yoplanning team will then enter the ffv_structure_id into your team's data.

Without this identifier, FFV integration cannot function.

Step 2: Verify the automatic creation of the FFV email template

Once the module is activated:

  • An FFV email template is automatically created for the team.

  • This email contains the link allowing the customer to finalize the creation of their license.

  • It is sent at the same time as the post-booking email.

  • This is a separate email.

You can view it in: Settings → Emails

Step 3: Create the “FFV Licenses” resources

In the left-hand menu:

  1. Go to Resources

  2. Click on Add

  3. Create a new resource

  4. Fill in the required fields as you wish, respecting the mandatory fields below which allow FFV licenses to be mapped.

Required parameters:

  • Partner tag: select FFV

  • Model: Enter exactly one of the following values:

⚠️ Strictly adhere to spelling.

Afterwards :

  • Enter the price

  • Add a clear description

  • Save

Best practice: create a separate resource for each type of license sold.

Step 4: Configure the product

In the left-hand menu:

  1. Go to Products

  2. Open the product in question

4.1 Make FFV information mandatory

In the participant settings, make the following mandatory:

  • Name

  • First name

  • Date of birth

  • Gender

The Gender field must exist in the client file.

Configuration → Client file

These 4 fields are essential for querying the FFV.

4.2 Add FFV licenses as an optional product feature

Still within the product:

  1. Go to the Options section

  2. Add the previously created FFV license resources

  3. Save

You choose which licenses to offer on each product.

Example :

  • Leisure course → PASSFFV

  • Competition → YOUTH_CLUB or ADULT_CLUB

Where can I see the FFV status in Yoplanning?

An FFV logo appears next to the participant's name in:

  • Session details

  • Manage participants

  • Participant list

Meaning

🟢 Green: Valid license for the session 🟠 Orange: License missing, expired, or non-compliant

Expiry dates are taken into account automatically.

Best practices

  • Always make all 4 fields mandatory.

  • Check the exact spelling of the model in the resources.

  • Testing a complete purchase before it opens to the public.

  • Check the FFV email template after activation.

  • Limit the licenses offered to those that are truly necessary.

Common problems and solutions

The FFV logo remains orange

Check :

  • Are all 4 pieces of information complete?

  • Has the license expired?

  • Does the identity match exactly (spelling, date, gender)?

The license is not created after purchase.

Check :

  • Did the customer complete the form received by email?

  • Is the FFV module properly activated?

  • Has the FFV structure identifier been provided to support?

  • Does the resource contain the FFV partner tag?

  • Is the model strictly compliant?

The licenses do not appear in the product

Check :

  • Resources are available in Resources

  • They are indeed added as an option in the product.

  • The product is indeed the one used by the booking module.

Summary

The FFV integration in Yoplanning allows:

  • Online sales of FFV licenses

  • Automatic verification of existing licenses

  • A simple visual inspection for the BE

  • A direct connection to the official API of the French Sailing Federation

A correct configuration ensures smooth, automated and compliant management of FFV licenses in Yoplanning.pro.

PreviousDefine an order for your product options.NextFees (Setup)

Last updated