Teach on Mars Mobile Learning solutions

Webservices
API
Teach on Mars
Mobile Learning solutions
(c) 2015 Teach on Mars - Webservices API - page !1
Sommaire
1. Introduction
3
2. Présentation
4
3. Webservices
8
4. Documentation
9
(c) 2015 Teach on Mars - Webservices API - page !2
1. Introduction
Ce document est une introduction aux webservices mis à disposition des partenaires de
Teach on Mars.
Le Data Center expose des webservices qui permettent d’effectuer les actions suivantes :
• Gestion des apprenants
• Récupération des données pédagogiques apprenants
• Gestion des formations
• Gestion du contenu d’une formation
Pour toute question ou remarque, n’hésitez pas à nous contacter :
Nicolas Goutaland
CTO
1047 route des Dolines - Allée Pierre Ziller
06560 Sophia-Antipolis - France
Tel. +(33)4 89 86 69 79
[email protected]
(c) 2015 Teach on Mars - Webservices API - page !3
2. Présentation
2.1 Architecture
API
Data center
Mission Center
API
Partenaire
Applications mobiles
(c) 2015 Teach on Mars - Webservices API - page !4
Le Mission Center désigne l'interface web permettant d’interagir avec le Data center, de
gérer les apprenants, de gérer le contenu et de consulter les statistiques et remontées de
données pédagogiques des apprenants. Ce Mission center communique via webservices
avec le Data Center.
Teach on Mars permet à ses partenaires d’utiliser cet ensemble de webservices. Ainsi,
toutes les actions réalisables depuis le Mission Center correspondent à un appel de
webservice, facilitant ainsi l’intégration d’un partenaire.
En revanche, les applications mobiles développées par Teach on Mars interagissent
directement avec le Data Center.
2.2 Sécurité
La communication avec les webservices s’effectue uniquement en https, et tous les appels
nécessitent une clé d’API privée.
Chaque requête doit donc comporter les entêtes suivants :
X-TOM-RTS : timestamp
X-TOM-API-HASH : SHA256(API_KEY + timestamp)
(c) 2015 Teach on Mars - Webservices API - page !5
2.3 SSO
Il est possible de mettre en place un système de SSO, permettant au partenaire de ne pas
stocker les couples login / mot de passe sur notre Data Center. En revanche, la création de
comptes sera obligatoire sur notre serveur, afin d’associer les remontées d’informations
pédagogiques à un compte apprenant.
Data center
Authentification standard
Partenaire
SSO
Applications mobiles
Data center
Applications mobiles
(c) 2015 Teach on Mars - Webservices API - page !6
L’activation du SSO chez le partenaire consiste en la mise à disposition d’un webservice
avec les caractéristiques suivantes :
• L’URL doit être accessible en GET par le Data Center de Teach on Mars
• Ce web service doit prendre 2 paramètres “login” et “password”
• Ce webservice doit retourner une réponse en JSON, avec le content-type
application/json
• Conseillé : Ce webservice doit être en HTTPS
Le format de retour attendu est le suivant :
{
"meta": {
"msg": "",
"status": 200
},
"response": {
"auth": true / false
}
}
(c) 2015 Teach on Mars - Webservices API - page !7
3. Webservices
3.1 Gestion des apprenants
• Import / création d’apprenants
• Modification d’apprenants existants
Il n’est pas possible de supprimer un apprenant. Celui-ci peut en revanche être désactivé.
Des métadonnées peuvent être associées aux apprenants afin de faciliter le filtrage lors de
l’export de données par exemple. Dans le cas de l’intégration de la solution Teach on Mars
au sein d’un LMS existant, il est tout à fait possible d’associer une metadonnée permettant
d’identifier l’apprenant dans le système existant.
3.2 Données pédagogiques / statistiques
• Extraction des données pédagogiques générées pour un ou plusieurs apprenants
• Récupération des données pédagogiques brutes générées par les applications
• Récupération des données affichées dans les tableaux de bord du Mission Center
Toutes ces données sont récupérables via webservices. En revanche, il est pas possible
d’injecter des données pédagogiques au sein du Data center. Seules les applications
peuvent le faire.
3.3 Gestion des formations
• Création d’une formation
• Suppression d’une formation
• Gestion des droits d’accès à une formation par apprenant
Cette fonctionnalité sera disponible dès Septembre 2015.
3.4 Gestion du contenu d’une formation
Cette fonctionnalité est déjà présente dans le Mission Center, mais n’est pour le moment
pas exposée via webservices.
La mise à jour du contenu se fera donc exclusivement via notre interface.
(c) 2015 Teach on Mars - Webservices API - page !8
4. Documentation
La documentation complète des webservices est disponible à l’URL suivante
http://sandbox.teachonmars.com/tom-webservices/public/doc/api
(c) 2015 Teach on Mars - Webservices API - page !9