Skip to main content

Intégrations d'API REST

Note

Cette documentation a été traduite à l'aide d'un outil de traduction automatique assisté par l'IA. Les traductions sont fournies « telles quelles », sans aucune garantie quant à leur exactitude. La version anglaise de ce contenu fait foi.

Blackboard LMS fournit un accès public à une suite d'API REST qui permettent aux développeurs de créer des applications personnalisées qui accèdent à Blackboard LMS. Pour en savoir plus sur nos partenaires d'intégration, rendez-vous sur le catalogue d'applications Blackboard.

Pourquoi utiliser les API REST ?

Utiliser des API REST permet aux développeurs de créer des applications qui ne sont que faiblement couplées au serveur Blackboard LMS. Elles peuvent être hébergées n'importe où. Le serveur peut ainsi fournir des informations sans que les API risquent d'interférer avec lui.

Sécurité avec les API REST

Les API REST peuvent fonctionner sous divers modèles de sécurité. Blackboard LMS L'autorisation de l'API REST utilise la norme du secteur OAuth 2.0. Cette norme permet de créer des requêtes en fonction des privilèges définis par l'administrateur de Blackboard LMS. De plus, les applications peuvent utiliser une variante à trois étapes du protocole. Cette approche authentifie les applications en tant qu'utilisateurs spécifiques de Blackboard LMS sans partager leurs informations d'identification. Les utilisateurs se connectent pour autoriser l'application à agir en leur nom. L'application n'obtient alors que le niveau d'accès dont bénéficie cet utilisateur.

Important

Il est préférable d'accorder aux utilisateurs de l'intégration les privilèges minimaux nécessaires pour utiliser l'outil intégré, et non les autorisations d'administrateur système complètes.

Qu'est-il possible de faire avec les API REST ?

Vous pouvez demander l'accès aux API REST Blackboard via le portail des développeurs. Une fois votre application enregistrée, nous générerons une clé et un secret uniques qui vous permettront de passer des appels et d'obtenir les données dont vous avez besoin pour intégrer votre application à notre plateforme. Les applications REST peuvent par exemple accéder aux éléments suivants :

  • annonces

  • cours

  • contenu

  • pièces jointes

  • devoirs

  • notes

Pour obtenir la liste complète des points de terminaison REST mis à la disposition des développeurs, consultez la documentation de l'API REST Blackboard. Vous pouvez également en savoir plus sur le framework de l'API REST Blackboard et trouver des informations sur les premiers pas avec l'API REST.

Enregistrer une intégration REST dans Blackboard LMS

Blackboard LMS prend en charge l'intégration d'applications externes créées à l'aide des API REST Blackboard LMS. Avant de pouvoir utiliser une intégration avec Blackboard LMS, un administrateur doit l'enregistrer dans Blackboard LMS.

Avant de commencer à enregistrer l'application, vous devez obtenir un ID d'application. Le développeur peut fournir l'ID directement à l'administrateur ou le joindre à la documentation d'assistance de l'application.

  1. Dans le panneau de configuration de l'administrateur, sous Intégrations, sélectionnez Intégrations d'API REST.

  2. Sélectionnez Créer une intégration.

  3. Dans le champ ID de l'application, saisissez l'ID de l'application fourni lors de l'enregistrement de celle-ci sur le portail des développeurs de Blackboard.

  4. À côté de Utilisateur Learn, sélectionnez Parcourir. Recherchez l'utilisateur Blackboard LMS au nom duquel l'intégration doit agir. En règle générale, une intégration agit en qualité d'administrateur ou d'un autre utilisateur créé pour gérer l'intégration. Idéalement, l'utilisateur dispose uniquement des autorisations nécessaires au bon fonctionnement de l'intégration.

  5. Pour l'intégration d'un tiers, définissez Accès d'utilisateur final sur Oui. Les utilisateurs finaux se connecteront avec leur propre identifiant Blackboard LMS pour utiliser l'intégration. L'accès de chaque utilisateur est alors limité à ses propres autorisations. Si vous définissez l'Accès de l'utilisateur final sur Non, l'intégration conservera l'accès de l'utilisateur Blackboard LMS indiqué sur le formulaire.

  6. Sélectionnez Valider pour enregistrer vos paramètres.