Paper Contacter le support | état du système L'état du système
Contenu de la page

    CMS API Notifications

    Dans ce sujet, vous en apprendrez plus sur CMS API notifications. le CMS API fournit des notifications de modification des vidéos de votre compte, qu’elles aient été apportées par un utilisateur du compte ou Video Cloud système.

    Vue d'ensemble

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

    Authentification

    Comme toutes les demandes au CMS API, les demandes de configuration ou de liste des notifications de souscription 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 disposer d'autorisations pour video-cloud/notifications/all (CMS->Notifications si vous utilisez le Studio UI pour créer les informations d'identification.)

    installation

    Vous pouvez spécifier jusqu'à des points de terminaison 10 pour recevoir des notifications en effectuant un POST demande à https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions et 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

    Article Description
    timestamp moment où l'événement s'est produit dans Epoch millisecondes
    account_id le Video Cloud identifiant de compte
    event le type d'événement - actuellement ce sera toujours video-change
    video l'identifiant de la 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 un HTTP 422 réponse d'erreur pour les conditions suivantes:

    • Le système endpoint or events champ est manquant dans le corps de la requête
    • Le système events la valeur du champ n'est pas une liste (tableau)
    • L'abonnement défini existe déjà
    • Vous avez déjà des abonnements 10 à cet événement

    Échecs de notification

    Le système de notification traite tout 4xx or 5xx retour du serveur client en tant qu'échec réessayable. Les rappels défaillants seront réessayés jusqu'à 20, avec un délai exponentiellement croissant entre les rappels ultérieurs. Les premières tentatives se produisent dans les minutes qui suivent la tentative de rappel initiale. Si le rappel continue à échouer, et que nous obtenons tout le chemin jusqu'à la nouvelle tentative 20th, le délai de nouvelle tentative sera de quelques jours.

    Les pare-feu

    Si votre organisation applique une politique stricte concernant les sources de trafic entrant via votre pare-feu, nous autorisons les adresses IP AWS us-east-1 / Virginia. Cela est sujet à modification. Par conséquent, toutes les adresses IP AWS doivent figurer sur la liste blanche. Voir http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html pour plus d’informations.

    Endpoint pour les abonnements de notification

            /accounts/{account_id}/subscriptions
            
            

    Créer un nouvel abonnement

    Pour créer un nouvel abonnement, envoyez un POST demande avec un corps de la demande, y compris le noeud final auquel vous souhaitez que les notifications soient envoyées et video-change comme l'élément unique dans un events tableau:

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

    Obtenez la liste de vos abonnements

    Pour obtenir une liste de tous vos abonnements, envoyez un 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:

    Endpoint

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

    A GET demande va récupérer 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 les événements sont déclenchés par tout changement dans les métadonnées de la vidéo. Cela inclut toute modification de la vidéo réalisée dans Studio ou via un CMS API méthode d'écriture. Il y a aussi des événements système qui vont déclencher video-change événements.

    Les modifications qui déclencheront un événement incluent:

    • Une vidéo est créée
    • L'ingestion de la vidéo ou du fichier d'actif commence
    • L'ingestion de vidéo ou de fichier d'actif est terminée
    • Le codage d'un nouveau rendu se termine
    • Une image de poster 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 par un utilisateur)

    Remarques

    Retranscoder une vidéo ne déclenchera pas de video-change événement à moins que le jeu de rendu résultant soit différent.

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

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


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