assistance Contacter le support | Étatétat du système du système
Contenu de la page

    Présentation : API du système de livraison

    Dans cette rubrique, vous obtiendrez une vue d'ensemble des API du système de distribution, 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 les fichiers liés au lecteur, comme les fichiers JavaScript et CSS pour les plugins personnalisés.

    Présentation

    Les fichiers associés au Delivery System sont gérés via les API REST, et éventuellement via Git. Ces fichiers sont remis à players.brightcove.net soit par un appel API, soit par un « git push ».

    Si vous n'avez pas traversé l' étape par étape : API Delivery System, il est fortement suggéré que vous commenciez par là. Vous obtiendrez une configuration de sécurité, apprenez certaines des bases du système, puis serez prêt à plonger plus loin ici.

    Voir également la référence de l'API.

    API REST du système de livraison

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

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

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

    L' étape par étape : Delivery System fournit un guide pratique pour l'utilisation des API Delivery System.

    Authentification

    Vous pouvez vous autoriser en utilisant des jetons d'accès OAuth ou via l'authentification de base en utilisant votre nom d'utilisateur et 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 pour l'utilisation en ligne de commande et le démarrage.

    Nous utiliserons l'authentification de base dans les exemples étape par étape . Si vous vouliez utiliser des jetons d'accès à la place, modifiez :

        --user $EMAIL

    en :

        --header "Authorization: Bearer $ACCESS_TOKEN"

    Réponses d'erreur API

    Il existe un certain nombre de réponses d'erreur possibles qui peuvent être renvoyées au format JSON lorsqu'il y a un problème avec un appel d'API REST :

    • Si vous essayez d'appeler une API qui n'existe pas, y compris une erreur d'orthographe des appels d'API existants, vous obtiendrez un code d'état 404 et un message utile sur ce que vous avez peut-être fait de mal.
    • Si votre appel ne peut pas être authentifié ou autorisé, vous obtiendrez un code d'état 403. Essayez à nouveau de consulter le guide OAuth pour vous assurer que vous disposez d'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.
    • En cas de problème avec le traitement de votre demande, vous obtiendrez un code d'état 500 et une réponse d'erreur standard Brightcove.

    La réponse d'erreur standard Brightcove mentionnée ci-dessus est une réponse JSON contenant error_code et propriétés de 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
    • ACCESS_TOKEN_ERROR: le jeton d'accès donné n'était pas valide
    • INVALID_API_CALL: l'appel API n'a pas été formaté correctement
    • NOT_FOUND: l'appel d'API ne pointait pas vers une ressource connue ou n'a pas été formaté correctement
    • NO_PUT_CONTENTS: Un formulaire multi-parties avec une clé de contenu doit être utilisé pour PUT un fichier repo
    • CREATE_REPO_ERROR: une erreur s'est produite 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 provoqué l'échec des choses
    • UNKNOWN_ERROR: une erreur qui n'a pas de code d'erreur associé s'est produite

    Contraintes