Démarrage rapide : API OAuth

Ce tutoriel vous guide à travers les étapes pour obtenir les informations d'identification client et un jeton d'accès à l'aide de l'API OAuth.

Exigences

  • Les appels d'API dans ce didacticiel utilisent cURL, qui est intégré à MacOS et à tous les systèmes linux/unix. Si vous utilisez Windows, consultez Configurer cURL
  • Vous aurez besoin de Terminal ou d'une autre console de ligne de commande pour votre système

Aperçu

L'utilisation de l'API Brightcove OAuth pour accéder à d'autres API Brightcove comporte 2 parties

  • Obtenez des informations d'identification client (a client_id et client_secret) valides pour les comptes et les opérations d'API dont vous avez besoin. Il s'agit d'une opération unique, à condition de sauvegarder votre client_id et votre client_secret dans un endroit sécurisé pour une utilisation ultérieure
  • Obtenez une access_token autorisation pour effectuer un appel d'API. Le access_token est valide pendant 5 minutes, donc dans la plupart des cas, vous en obtiendrez un pour chaque appel d'API que vous effectuez

Il existe également une interface utilisateur dans Studio que vous pouvez utiliser pour obtenir et gérer les informations d'identification des clients. Il est recommandé d'utiliser l'interface utilisateur dans la mesure du possible. Pour les nouvelles API, les informations d'identification peuvent ne pas être disponibles via l'interface utilisateur pendant un certain temps, auquel cas vous pouvez obtenir des informations d'identification directement à partir de l'API OAuth, comme vous apprendrez à le faire dans les étapes qui suivent.

Obtenir les informations d'identification du client

Dans ces étapes, nous utiliserons une commande cURL pour obtenir les informations d'identification du client pour l'API Player Management.

Étapes

  1. Assurez-vous que cURL est disponible comme expliqué dans la section Exigences ; vous pouvez le tester en accédant à une ligne de commande, en tapant curl et en appuyant sur return. Si cURL est installé, vous devriez voir un message comme celui-ci :
            curl: try 'curl --help' or 'curl --manual' for more information
  2. Vous avez maintenant besoin de deux informations que vous pouvez obtenir auprès de Studio. Connectez-vous à Studio en allant sur Studio.
    • identifiant de compte
    • BC_TOKEN

    Remarque : Les BC_TOKEN value est un cookie défini lorsque vous ouvrez Studio. Cela n'a aucun rapport avec les jetons de gestion des API que vous traitez dans Studio.

Obtenez votre identifiant de compte et BC_TOKEN

  1. Vous aurez d'abord besoin de votre identifiant de compte à partir des informations de compte.
  2. Cliquez sur l'icône Paramètres Paramètres du compte dans l'en-tête Studio.
  3. Sélectionnez Informations sur le compte dans la liste déroulante.
  4. Copiez votre identifiant de compte depuis la page Informations sur le compte et enregistrez-le. Vous en aurez besoin ultérieurement.
  5. Ouvrez maintenant la console de développement du navigateur. Dans la plupart des navigateurs, vous pouvez le faire en appuyant sur Option-CMD-i (Mac) ou Alt-Ctrl-i (Windows), ou vous devriez également pouvoir trouver un élément de menu.
  6. Dans la console, collez le JavaScript suivant et appuyez sur retour pour afficher votre BC_TOKEN dans une boîte de dialogue modale :
  7. Copiez le BC_TOKEN dans le presse-papiers.
  8. Saisissez votre identifiant de compte et BC_TOKEN ici :

    Identifiant du compte :

    BC_JETON :

Faire la demande d'identifiants

  1. Pour obtenir vos informations d'identification client, copiez et collez la commande cURL suivante sur votre ligne de commande et appuyez sur Entrée :
  2. La réponse devrait ressembler à ceci (formatage ajouté) :
            {"redirect_url":null,"maximum_scope":[{"identity":
            {"type":"video-cloud-account","account-id":57838016001},
            "operations":["video-cloud/player/all"]}],"name_html":"Sample-Client",
            "issued_to":"rcrooks@brightcove.com","trusted":null,"expires_at":null,
            "issued_at":"2015-06-18T20:17:12Z","name":"Sample-Client",
            "description_html":null,"revoked":null,"type":"credential",
            "client_secret":"PiQ5s3-tk46DvNBPauknctP3aTIS07zNIa7Kxz3b7hnRMA5JvQdkwa7JpyuX7dnD4RXziA4KEK0n1pEO94Q7,
            "description":null,"client_id":"b63e5ac2-5264-4a5a-971a-a133bc7bd605",
            "issued_user":53255203001}

    Il ne s'agit pas d'un secret client valide. Vous ne devez jamais divulguer un secret client publiquement.

  3. Entrez les valeurs pour le client_id et client_secret ci-dessous, car vous en aurez besoin à tout moment pour obtenir un access_token.
    Identifiants du client

    identifiant du client :

    client_secret :

Obtenez des jetons d'accès

Le client_id et client_secret que vous avez obtenu dans les étapes précédentes sont utilisés comme Identifiant Mot de passe combinaison pour l'authentification lorsque vous demandez un access_token. Dans cURL, que nous utiliserons ici, vous pouvez les transmettre comme --user paramètre. Dans d'autres langues, vous les transmettrez dans un en-tête d'autorisation de base avec votre requête HTTP :

        Authorization: Basic {client_id:client_secret}

Remarque : l'intégralité du fichier client_id:client_secret doit être codée en Base64 pour être acceptée par l'API OAuth. cURL encodera automatiquement les informations d'identification --user en Base64, mais dans d'autres langues, vous devrez l'encoder vous-même en Base64.

Étapes

  1. Pour obtenir votre access_token, copiez et collez la commande cURL suivante dans votre ligne de commande et appuyez sur Entrée :
  2. La sortie devrait ressembler à ceci :
            {"access_token":"ACkkpftcuhyzqdf4ftxm304za3anhziG0Ni5-S_dplxMNYNrSrBZRgJL3sf_U38ZZVDdgkmWtrb0_GRZj-VzWOAFWgpEYwgwIWLjcGsTI-9QMUMNv2eFj33clsWFHnGLzgtdcILXpR-wPM0LzKKzRahodwofPfuExYCej18Wpt1x7DxOJDySEjCGOWiTuZVKp1QjG0_nqD9T3TpK3Cchv0suVRTGkYrs15qYSKdxh2-e5XbUiKKptNl8ryvMriavPN66fOh17c09Q0525OPqejkU6uERPTw-sTLU_QjJbRV6psxoSVYKRAetsBikH9XRJbZCSt2JP88O","token_type":"Bearer","expires_in":300}
  3. Ce jeton peut être utilisé pour authentifier les appels à l'API de gestion des joueurs pendant 5 minutes (vous devez ensuite obtenir un nouveau jeton). Le jeton est passé dans l'en-tête Authorization avec la requête HTTP :
            Authorization: Bearer access_token value