Inscriptions

Gérez les inscriptions des apprenants et suivez leur progression.

Schéma Enrollment

Champs du modèle Enrollment
Champ	Type	Description
id	string	Identifiant unique (enr_...)
courseId	string	ID de la formation
userId	string	ID de l'apprenant
status	enum	ACTIVE \| COMPLETED \| SUSPENDED \| REVOKED
paymentMethod	enum	FREE \| VIVA_ISV \| STRIPE
paymentId	string?	ID du paiement associé (si payant)
enrolledAt	string	Date d'inscription (ISO 8601)
completedAt	string?	Date de completion (null si non terminé)
expiresAt	string?	Date d'expiration d'accès (null = illimité)

POST/enrollments

Crée une inscription. Modes de paiement : FREE (interne), VIVA_ISV, STRIPE (flux de paiement requis).

Inscrire un apprenant · Python

import requests

# Inscription gratuite (formation interne)
response = requests.post(
    'https://api.qualiforma.site/api/v1/enrollments',
    headers={
        'Authorization': f'Bearer {access_token}',
        'X-Tenant-ID': 'votre-tenant',
        'Content-Type': 'application/json'
    },
    json={
        'courseId': 'crs_abc123',
        'userId': 'usr_xyz789',
        'paymentMethod': 'FREE'
    }
)
enrollment = response.json()['data']
print(f"Inscription {enrollment['id']} — statut : {enrollment['status']}")

Inscrire un apprenant · cURL / Shell

TOKEN="eyJhbGci..."

curl -X POST https://api.qualiforma.site/api/v1/enrollments \
  -H "Authorization: Bearer $TOKEN" \
  -H 'X-Tenant-ID: votre-tenant' \
  -H 'Content-Type: application/json' \
  -d '{
    "courseId": "crs_abc123",
    "userId": "usr_xyz789",
    "paymentMethod": "FREE"
  }'

Inscrire un apprenant · TypeScript

const response = await fetch('https://api.qualiforma.site/api/v1/enrollments', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${accessToken}`,
    'X-Tenant-ID': tenantId,
  },
  body: JSON.stringify({
    courseId: 'crs_abc123',
    userId: 'usr_xyz789',
    paymentMethod: 'FREE',
  }),
});
const { data: enrollment } = await response.json();

Inscrire un apprenant · PHP

<?php
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client(['base_uri' => 'https://api.qualiforma.site/api/v1/']);

try {
    // Inscription gratuite (formation interne)
    $response = $client->post('enrollments', [
        'headers' => [
            'Authorization' => 'Bearer ' . $accessToken,
            'X-Tenant-ID' => 'votre-tenant',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'courseId' => 'crs_abc123',
            'userId' => 'usr_xyz789',
            'paymentMethod' => 'FREE',
        ],
    ]);
    $enrollment = json_decode($response->getBody()->getContents(), true)['data'];
    echo "Inscription {$enrollment['id']} - statut : {$enrollment['status']}\n";
} catch (GuzzleException $e) {
    fwrite(STDERR, "Erreur: " . $e->getMessage() . PHP_EOL);
}

GET/enrollments/:id/progress

Retourne la progression détaillée de l'apprenant : leçons complétées, pourcentage, date de completion.

Progression d'un apprenant · cURL / Shell

TOKEN="eyJhbGci..."
ENROLLMENT_ID="enr_def456"

curl "https://api.qualiforma.site/api/v1/enrollments/$ENROLLMENT_ID/progress" \
  -H "Authorization: Bearer $TOKEN" \
  -H 'X-Tenant-ID: votre-tenant'

# Réponse :
# {
#   "data": {
#     "enrollmentId": "enr_def456",
#     "progressPercent": 45,
#     "completedLessons": 9,
#     "totalLessons": 20,
#     "completedAt": null,
#     "lastActivityAt": "2026-01-15T14:30:00Z"
#   }
# }