Référence API
Démarrer une offre gratuite
Démarrer une demande d’offre gratuite avec ou sans OTP.
POST /api/portal/free-offer/startAccès : Public
Corps de requête
{
"companyReference": "readyzone-center-12345",
"planId": "plan_uuid",
"phone": "699112233",
"macAddress": "AA:BB:CC:DD:EE:FF",
"ipAddress": "192.168.88.20",
"userAgent": "Mozilla/5.0"
}companyReference, planId et phone sont obligatoires. macAddress est requis pour les offres limitées à un smart device.
Réponse
{
"claimToken": "claim_token",
"otpRequired": true,
"expiresAt": "2026-10-17T12:00:00.000Z",
"plan": {
"id": "plan_uuid",
"name": "Découverte gratuite",
"type": "smart-device-based",
"frequency": "daily"
}
}| Attribut | Type | Description |
|---|---|---|
claimToken | string | Jeton temporaire à transmettre à l’étape de vérification. |
otpRequired | boolean | Indique si un OTP doit être saisi. |
expiresAt | string (ISO 8601) | Date d’expiration de la réclamation. |
plan | object | Résumé du forfait gratuit sélectionné. |
Codes de statut
- 200 OK
- 400 Bad Request (données invalides)
- 404 Not Found (offre ou zone introuvable)
- 409 Conflict (offre déjà réclamée)
- 429 Too Many Requests (limite anti-abus)