Inicio rápido: API de OAuth

Este tutorial lo guía a través de los pasos para obtener credenciales de cliente y un token de acceso mediante la API de OAuth.

Requisitos

  • Las llamadas a la API en este tutorial usan cURL, que está integrado en MacOS y en todos los sistemas Linux / Unix. Si está ejecutando Windows, consulte Configurar cURL
  • Necesitará Terminal o alguna otra consola de línea de comandos para su sistema

Resumen

Hay 2 partes para usar la API de Brightcove OAuth para obtener acceso a otras API de Brightcove

  • Obtener credenciales de cliente (una client_id y client_secret ) que son válidos para la(s) cuenta(s) y la(s) operación(es) de API que necesita: esta es una operación única, siempre que guarde su client_id y client_secret en algún lugar seguro para uso futuro
  • Conseguir un access_token que proporciona autorización para realizar una llamada a la API: el access_token es válido durante 5 minutos, por lo que en la mayoría de los casos obtendrá uno por cada llamada a la API que realice

También hay una interfaz de usuario en Studio que puede usar para obtener y administrar las credenciales del cliente. Se recomienda que utilice la interfaz de usuario siempre que sea posible. Para las API nuevas, es posible que las credenciales no estén disponibles a través de la interfaz de usuario durante algún tiempo, en cuyo caso puede obtener las credenciales directamente de la API de OAuth, como aprenderá a hacerlo en los pasos siguientes.

Obtenga las credenciales del cliente

En estos pasos, usaremos un comando cURL para obtener las credenciales del cliente para la API de administración de jugadores.

Pasos

  1. Asegúrese de tener cURL disponible como se explica en Requisitos ; puede probar yendo a una línea de comando y escribiendo curl y presionando regresar - si cURL está instalado, debería ver un mensaje como este: 
            curl: try 'curl --help' or 'curl --manual' for more information
  2. Ahora necesita dos piezas de información que puede obtener de Studio. Inicie sesión en Studio yendo a Estudio.
    • ID de la cuenta
    • BC_TOKEN

    Nota: La BC_TOKEN value es un conjunto de cookies cuando abre Studio. No tiene relación con los tokens de administración de API con los que trabaja en Studio.

Obtenga su ID de cuenta y BC_TOKEN

  1. Primero necesitará su identificación de cuenta de la Información de la cuenta.
  2. Haga clic en el icono de configuración Configuración de cuenta en el encabezado de Studio.
  3. Seleccione Información de la cuenta en el menú desplegable.
  4. Copie la identificación de su cuenta de la página Información de la cuenta y guárdela; la necesitará en un paso posterior.
  5. Ahora abra la consola del desarrollador del navegador; en la mayoría de los navegadores, puede hacer esto presionando OPCIÓN-CMD-i (Mac) o ALT-CTRL-i (Windows), o también debería poder encontrar un elemento de menú.
  6. En la consola, pegue el siguiente JavaScript y presione retorno para mostrar su BC_TOKEN en un diálogo modal:
  7. Copie BC_TOKEN en el portapapeles.
  8. Ingrese su ID de cuenta y BC_TOKEN aquí:

    ID de la cuenta:

    BC_TOKEN:

Realizar la solicitud de credenciales

  1. Para obtener sus credenciales de cliente, copie y pegue el siguiente comando cURL en su línea de comando y presione retorno:
  2. La respuesta debería verse así (formato agregado): 
            {"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}

    Esto es no un secreto de cliente válido; debe Nunca exponer públicamente un secreto de cliente.

  3. Ingrese los valores para el client_id y client_secret a continuación, ya que los necesitará cada vez que necesite obtener un access_token.
    Credenciales de cliente

    Identificación del cliente:

    client_secret:

Obtener tokens de acceso

La client_id y client_secret que obtuvo en los pasos anteriores se utilizan como usuario Contraseña combinación para la autenticación cuando solicita una access_token. En cURL, que usaremos aquí, puede pasarlos como --user parámetro. En otros idiomas, los pasará en un encabezado de autorización básica con su solicitud HTTP:

        Authorization: Basic {client_id:client_secret}

Nota: el client_id completo: client_secret deber estar codificado en Base64 para ser aceptado por la API de OAuth. cURL codificará en Base64 las credenciales de usuario automáticamente, pero en otros idiomas necesitará codificarlas en Base64 usted mismo.

Pasos

  1. Para obtener su access_token, copie y pegue el siguiente comando cURL en su línea de comando y presione enter:
  2. La salida debería verse así: 
            {"access_token":"ACkkpftcuhyzqdf4ftxm304za3anhziG0Ni5-S_dplxMNYNrSrBZRgJL3sf_U38ZZVDdgkmWtrb0_GRZj-VzWOAFWgpEYwgwIWLjcGsTI-9QMUMNv2eFj33clsWFHnGLzgtdcILXpR-wPM0LzKKzRahodwofPfuExYCej18Wpt1x7DxOJDySEjCGOWiTuZVKp1QjG0_nqD9T3TpK3Cchv0suVRTGkYrs15qYSKdxh2-e5XbUiKKptNl8ryvMriavPN66fOh17c09Q0525OPqejkU6uERPTw-sTLU_QjJbRV6psxoSVYKRAetsBikH9XRJbZCSt2JP88O","token_type":"Bearer","expires_in":300}
  3. Este token se puede usar para autenticar llamadas a la API de administración de jugadores durante 5 minutos (luego debe obtener un nuevo token). El token se pasa en el encabezado de autorización con la solicitud HTTP: 
            Authorization: Bearer access_token value