Guides
Démarrage
Ce guide obtient un jeton d’accès puis liste les utilisateurs de votre organisation. Remplacez https://api.example.com par l’adresse de l’API de votre environnement InTeach, affichée dans l’écran d’administration du client.
1. Créer un client d’intégration
Dans l’administration InTeach, un administrateur ouvre Paramètres › API et intégrations › Clients OAuth, choisit un nom et les scopes nécessaires, par exemple users:read. Le secret (ics_…) n’est affiché qu’une seule fois : enregistrez-le immédiatement dans votre coffre de secrets.
2. Obtenir un jeton
curl -s https://api.example.com/oauth/token \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-d grant_type=client_credentials \
-d scope="users:read"
{ "access_token": "…", "token_type": "Bearer", "expires_in": 900, "scope": "users:read" }
Le jeton est valable 15 minutes. Redemandez-en un à l’expiration : il n’y a pas de jeton de rafraîchissement pour ce flux.
3. Appeler l’API
curl -s "https://api.example.com/api/v1/users?limit=50" \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"data": [
{ "id": 42, "email": "ada@example.org", "firstname": "Ada", "lastname": "Lovelace",
"role": "LEARNER", "status": "active", "createdAt": "…", "updatedAt": "…" }
],
"pagination": { "nextCursor": "eyJ2IjoxLCJhIjo0Mn0" }
}
Pour la page suivante, renvoyez cursor=<nextCursor> avec les mêmes filtres. nextCursor: null signale la dernière page.
4. Créer et inscrire un apprenant
curl -s https://api.example.com/api/v1/enrollments \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Idempotency-Key: hr-onboarding-2027-0042" \
-H "Content-Type: application/json" \
-d '{ "sessionId": 12, "user": { "email": "ada@example.org", "firstname": "Ada" }, "invite": true }'
Ce client doit disposer des scopes enrollments:write et users:write. Rejouer la même requête avec la même clé renvoie la même réponse sans effet supplémentaire.
Et ensuite
- Authentification et scopes
- Conventions de l’API : pagination, erreurs, idempotence, limites
- Référence complète