Paper Contacter le support | état du système L'état du système

Aperçu: Delivery System API

Dans cette rubrique, vous obtiendrez un aperçu de la Delivery System APIs, qui permettent la gestion et le déploiement d'un groupe de fichiers, appelé référentiel. Ce système a été configuré comme une zone de stockage pour player les fichiers associés, comme les fichiers JavaScript et CSS pour les plugins personnalisés.

Vue d'ensemble

Les fichiers associés au système de diffusion sont gérés via les API REST, et éventuellement via Git. Ces fichiers sont livrés à players.brightcove.net soit par un appel d'API, soit par un "git push".

Si vous n'êtes pas passé par le Pas à pas: Delivery System API, il est fortement suggéré que vous commenciez là. Vous obtiendrez des informations sur la sécurité, apprendrez les bases du système et serez prêt à plonger plus loin ici.

Voir aussi le Référence de l'API.

API REST du système de diffusion

Les API du système de distribution sont centrées sur des référentiels, également appelés repos. Vous pouvez gérer les dépôts via un groupe d'API REST qui vous permettent d'ajouter, d'obtenir et de répertorier vos mises en attente. Vous pouvez également utiliser des appels d'API REST pour manipuler des fichiers dans des repos.

Vous pouvez utiliser l'outil de ligne de commande curl pour utiliser les API REST. Les API REST retournent les réponses au format JSON contenant les informations suivantes en cas de succès:

  • name: Le nom du repo. C'est la même chose que le nom trouvé dans les URL de l'API REST.
  • public_url: L'URL de base où les fichiers repo peuvent être vus.

Le système d'implants dentaires Pas à pas: système de livraison fournit un guide pratique pour utiliser le Delivery System APIs.

Authentification

Vous pouvez vous autoriser à utiliser soit Jetons d'accès OAuth ou via l'authentification de base en utilisant votre nom d'utilisateur et votre mot de passe Brightcove. Les jetons d'accès OAuth standard doivent être utilisés pour toute utilisation programmatique des API, mais la route d'authentification de base est beaucoup plus facile à utiliser en ligne de commande et à démarrer.

Nous utiliserons l'authentification de base dans le Pas à pas exemples. Si vous souhaitez utiliser des jetons d'accès à la place, modifiez:

    --user $EMAIL

à:

    --header "Authorization: Bearer $ACCESS_TOKEN"

Réponses d'erreur API

Un certain nombre de réponses d'erreur possibles peuvent être renvoyées au format JSON en cas de problème avec un appel d'API REST:

  • Si vous essayez d'appeler une API qui n'existe pas, y compris une faute d'orthographe des appels API existants, vous obtiendrez un code d'état de 404 et un message utile sur ce que vous avez pu faire de mal.
  • Si votre appel ne peut être authentifié ou autorisé, vous obtiendrez un code d'état 403. Essayez de revoir le guide OAuth pour vous assurer d'avoir un jeton d'accès valide.
  • Si vous essayez d'utiliser une méthode autre que GET ou PUT, la réponse contiendra un code d'état 405.
  • S'il y a un problème avec le traitement de votre demande, vous obtiendrez un code d'état 500 et une réponse d'erreur Brightcove standard.

La réponse d'erreur Brightcove standard mentionnée ci-dessus est une réponse JSON contenant le code d'erreur et les propriétés du message. Le code d'erreur sera l'un des suivants:

  • INVALID_LOGIN_CREDENTIALS: le nom d'utilisateur et le mot de passe donnés lors de l'utilisation de l'authentification de base n'étaient pas valides
  • ACCESS_TOKEN_ERROR: le jeton d'accès donné n'était pas valide
  • INVALID_API_CALL: l'appel de l'API n'a pas été correctement formaté
  • NOT_FOUND: l'appel de l'API ne pointait pas vers une ressource connue ou n'était pas formaté correctement
  • NO_PUT_CONTENTS: Un formulaire en plusieurs parties avec une clé de contenu doit être utilisé pour METTRE un fichier repo
  • CREATE_REPO_ERROR: une erreur est survenue lors de la création d'un repo
  • GET_REPO_ERROR: une erreur s'est produite lors de l'obtention d'un repo
  • GET_REPOS_ERROR: une erreur s'est produite lors de l'obtention de tous les repos
  • UNCAUGHT_ERROR: une erreur non interceptée a fait échouer les choses
  • UNKNOWN_ERROR: une erreur sans code d'erreur associé s'est produite

Limites


Dernière mise à jour de la page le 12 juin 2020