Référence API
Disponibilité des offres gratuites
Lister les offres gratuites disponibles pour une zone.
GET /api/portal/free-offer/{companyReference}Accès : Public
Cas d’usage portail
Le portail charge cet endpoint pour savoir quelles offres gratuites sont disponibles avant d’afficher le formulaire de réclamation.
Paramètres
- companyReference (path, obligatoire)
Corps de réponse
{
"active": true,
"offers": [
{
"planId": "plan_uuid",
"name": "Découverte gratuite",
"description": "Accès gratuit limité",
"type": "smart-device-based",
"frequency": "once_per_day",
"durationHours": 2
}
]
}| Attribut | Type | Description |
|---|---|---|
offers | array | Offres gratuites disponibles. |
active | boolean | Indique si au moins une offre est disponible. |
offers[].planId | string | Identifiant du forfait gratuit. |
offers[].name | string | Nom du forfait. |
offers[].description | string ou null | Description du forfait. |
offers[].type | string | Type du forfait, notamment smart-device-based ou period-based. |
offers[].frequency | string ou null | unlimited, once_per_day, once_per_week, once_per_month ou once_per_year. |
offers[].durationHours | number | Durée de l’offre en heures. |
Codes de statut
- 200 OK
- 400 Bad Request (référence invalide)
- 404 Not Found (zone introuvable)