En développement
La documentation déjà publiée
L'API publique est documentée en français et en anglais, et les autres faits du produit sont sur les pages des normes et de la sécurité.
Ce que la documentation couvre aujourd'hui
Des chiffres du catalogue d'API publié, pas une liste à venir.
- Spécification OpenAPI
- 3.1Spécification OpenAPIPubliée à /docs/api
- Version de l'API
- 1Version de l'APILa spécification JSON est à /api/v1/openapi.json
- Langues officielles
- 2Langues officiellesChaque opération a un résumé français et un résumé anglais
- Retour silencieux à l'anglais
- 0Retour silencieux à l'anglaisUne chaîne française manquante fait échouer la compilation
Où se trouve chaque sujet
Une page par sujet, pour qu'un acheteur ne cherche pas dans un dépôt.
| Sujet | Où le lire |
|---|---|
| API REST | /docs/api, spécification OpenAPI 3.1 |
| SCORM 1.2 et 2004 | Page des normes, l'exportation est livrée |
| Énoncés xAPI | Page des normes, noyau LRS, pas de routes HTTP sur la branche principale |
| Contrôles de sécurité | Page de sécurité |
| Prix | Page des tarifs, devis, aucune grille |
Questions sur la documentation
Y a-t-il un guide produit ?
Pas encore. La spécification de l'API, la page des normes et la page de sécurité existent aujourd'hui.
Les résumés d'API sont-ils bilingues ?
Oui. Chaque opération porte un résumé français et un résumé anglais dans le document OpenAPI.
Où SCORM est-il documenté ?
Sur la page des normes. L'exportateur écrit SCORM 1.2 ou 2004 à partir du même cours.
Y a-t-il un point d'accès HTTP xAPI ?
Le magasin d'énoncés existe. Les routes HTTP ne sont pas sur la branche principale, donc nous ne les publions pas ici.
Posez une question de documentation
Écrivez en français ou en anglais. Nommez la page ou le point d'accès.