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

    Notifications API CMS

    Dans cette rubrique, vous découvrirez CMS API les notifications. Le CMS API fournit des notifications des modifications apportées aux vidéos de votre compte, qu'elles soient effectuées par un utilisateur de compte ou par le système Video Cloud.

    Présentation

    Vous pouvez recevoir des notifications lorsque des video-change événements se produisent dans votre vidéothèque. Les notifications seront envoyées à l'URL que vous spécifiez, qui doit pointer vers une application capable de gérer HTTP POST demandes.

    Authentification

    Comme toutes les requêtes adressées à l'API CMS, les demandes de configuration ou de liste d'abonnements aux notifications doivent être authentifiées à l'aide d'un jeton d'accès. Les informations d'identification client utilisées pour obtenir le jeton d'accès doivent avoir des autorisations pour video-cloud/notifications/all (CMS->Notifications si vous utilisez l' interface utilisateur de Studio pour créer les informations d'identification).

    Configuration

    Vous pouvez spécifier jusqu'à 10 points de terminaison pour recevoir des notifications en envoyant une POST requête à JSON https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions et en incluant JSON dans le corps de la requête comme ceci :

            {
            "endpoint":"http://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
            "events":["video-change"]
            }
            
            

    Les notifications sont envoyées au format JSON. Voici un exemple :

            {"timestamp":1423840514446,
            "account_id":"775205503001",
            "event":"video-change",
            "video":"4020894387001",
            "version":26}
            
            

    Champs de notification

    Produit Description
    timestamp heure à laquelle l'événement s'est produit en Epoch millisecondes
    account_id l'identifiant Video Cloud du compte
    event le type d'événement - actuellement ce sera toujours video-change
    video l'ID vidéo
    version la version de la vidéo - chaque ensemble d'événements de changement incrémente la version vidéo - par exemple, la création d'un nouvel ensemble de rendus constituerait un ensemble d'événements de changement

    Les demandes de création d'un abonnement recevront une réponse HTTP 422 d'erreur pour les conditions suivantes :

    • le endpoint ou events le champ est absent du corps de la requête
    • La valeur du events champ n'est pas une liste (tableau)
    • L'abonnement défini existe déjà
    • Vous avez déjà 10 abonnements à cet événement

    Échec de notification

    Le système de notification traite tout 4xx ou 5xx retour du serveur client en cas d'échec réessayable. Les rappels défaillants seront réessayés jusqu'à 20 fois, avec un délai exponentiellement croissant entre les rappels ultérieurs. Les premières tentatives se produiront dans les minutes suivant la tentative de rappel initiale. Si le rappel continue à échouer et que nous arrivons jusqu'à la 20e nouvelle tentative, le délai de nouvelle tentative sera de quelques jours.

    Pare-feu

    Dans le cas où votre organisation a une politique stricte concernant les sources de trafic entrant via votre pare-feu, nous autorisons les IP AWS US-East-1/Virginia. Ceci est sujet à changement, donc toutes les adresses IP AWS doivent être mises en liste blanche. Voir http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html pour plus d'informations.

    Point de terminaison pour les abonnements aux notifications

            /accounts/{account_id}/subscriptions
            
            

    Créer un nouvel abonnement

    Pour créer un nouvel abonnement, envoyez une POST demande avec un corps de demande, y compris le point de terminaison auquel vous souhaitez envoyer les notifications et en video-change tant qu'élément unique dans un events tableau :

            { "endpoint": "http://solutions.brightcove.com:9002", "events": [ "video-change" ] }
            
            

    Obtenir une liste de vos abonnements

    Pour obtenir la liste de tous vos abonnements, envoyez une GET demande au point de terminaison des abonnements.

    Obtenir ou supprimer un seul abonnement

    Utilisez le point de terminaison suivant pour obtenir ou supprimer un seul abonnement :

    Point de terminaison

            /accounts/{account_id}/subscriptions/{subscription_id}
            
            

    Une GET demande récupère l'abonnement. Une DELETE demande supprimera l'abonnement. Vous ne pouvez pas mettre à jour un abonnement pour le moment. Si vous souhaitez modifier un abonnement, vous devrez le supprimer et en créer un nouveau.

    Qu'est-ce qui déclenche les notifications ?

    video-change sont déclenchés par toute modification des métadonnées vidéo. Cela inclut toute modification apportée à la vidéo effectuée dans Studio ou via une méthode d' CMS API écriture. Il existe également des événements système qui déclencheront video-change des événements.

    Les modifications qui déclencheront un événement sont les suivantes :

    • Une vidéo est créée
    • L'ingestion d'une vidéo ou d'un fichier d'actifs démarre
    • L'ingestion d'une vidéo ou d'un fichier d'actifs est terminée
    • Le codage d'un nouveau rendu se termine
    • Une image d'affiche est créée
    • Une image miniature est créée
    • Une vidéo est supprimée
    • Les métadonnées vidéo sont modifiées (par le système ou un utilisateur)

    Remarques

    Le retranscodage d'une vidéo ne déclenche pas d' video-change événement, sauf si le jeu de rendu obtenu est différent.

    Il y a des événements système qui se produisent après la suppression d'une vidéo, de sorte que vous recevrez des notifications sur une vidéo après l'avoir supprimée.

    Ce qui ne déclenche pas un video-change événement est une modification d'une ressource vidéo qui ne modifie pas les métadonnées vidéo. Par exemple, si vous remplacez un fichier ou une image de piste texte distant, mais que l'URL enregistrée dans les métadonnées vidéo reste la même, aucun video-change événement ne se produit et aucune notification ne sera envoyée.