Files
ms1inscription-v5/v3/docs/api.md
2026-05-13 09:43:32 -04:00

4.9 KiB
Raw Blame History

API MS-1

MS-1 API

LAPI MS-1 permet aux partenaires daccéder aux événements, catégories et inscriptions.

The MS-1 API allows partners to access events, categories and registrations.


Authentification

Authentication

Pour accéder à lAPI, vous devez obtenir une clé API auprès de MS-1.

To access the API you must obtain an API key from MS-1.

Lors de la création de votre accès, MS-1 vous fournira :

When your access is created MS-1 will provide:

  • une clé API
  • lURL de base de lAPI
  • an API key
  • the API base URL

La clé API doit être envoyée dans lentête HTTP suivant :

The API key must be sent in the following HTTP header:

X-API-Key: YOUR_API_KEY

Si la clé est invalide ou absente, lAPI retourne :

If the API key is missing or invalid the API returns:

401 Unauthorized


Endpoints

Endpoints


GET /v1/events

Retourne la liste des événements accessibles au promoteur associé à la clé API.

Returns the list of events accessible to the promoter associated with the API key.

Paramètres optionnels

Optional parameters

Paramètre Description
start_date filtre par date de début
end_date filtre par date de fin
updated_since retourne les événements modifiés après cette date

Exemple

Example

GET /v1/events?start_date=2026-01-01&end_date=2026-12-31

Réponse

Response

{ "events": [ { "eve_id": 4501, "eve_nom_fr": "Triathlon Démo", "eve_lieu_fr": "Montréal", "eve_lieu_en": "Montreal", "eve_date_debut": "2026-06-21", "categories": [ { "category_id": 801, "epr_nom_fr": "Sprint", "epr_nom_en": "Sprint" } ] } ], "total": 1 }


GET /v1/events/{event_id}

Retourne les informations détaillées dun événement.

Returns detailed information for an event.

Exemple

Example

GET /v1/events/4501

Réponse

Response

{ "event": { "eve_id": 4501, "eve_nom_fr": "Triathlon Démo", "eve_lieu_fr": "Montréal", "eve_lieu_en": "Montreal", "eve_date_debut": "2026-06-21", "categories": [ { "category_id": 801, "epr_nom_fr": "Sprint", "epr_nom_en": "Sprint" } ] } }


GET /v1/events/{event_id}/categories

Retourne toutes les catégories dun événement.

Returns all categories for an event.

Exemple

Example

GET /v1/events/4501/categories

Réponse

Response

{ "event_id": 4501, "categories": [ { "category_id": 801, "eve_id": 4501, "epr_type_fr": "Triathlon", "epr_type_en": "Triathlon", "epr_nom_fr": "Sprint", "epr_nom_en": "Sprint" } ] }


GET /v1/events/{event_id}/registrations

Retourne les inscriptions pour un événement.

Returns registrations for an event.

Paramètres optionnels

Optional parameters

Paramètre Description
updated_since retourne les inscriptions modifiées après cette date
page pagination
per_page nombre déléments

Exemple

Example

GET /v1/events/4501/registrations

Réponse

Response

{ "registrations": [ { "registration_id": 98001, "event_id": 4501, "first_name": "John", "last_name": "Doe", "email": "participant@example.com", "category_id": 801, "order_id": "ORD-10001", "payment_status": "paid", "custom_questions": [ { "que_id": 12, "que_question_fr": "Grandeur de chandail", "que_question_en": "Tshirt size", "reponse": "M" } ] } ] }


Limitations

Limitations

Chaque clé API donne accès uniquement aux événements associés au promoteur.

Each API key only provides access to events associated with the promoter.


Support

Support

Pour toute demande daccès ou question technique, contactez MS-1.

For API access or technical questions, contact MS-1.