Telepresencia y entornos innovadores de colaboración humana. Usando Webex y APIs

Sigla Asignatura

CUY6142

Nombre de la Asignatura

Telepresencia y entornos innovadores de colaboración humana

Tiempo

2 horas

Experiencia de Aprendizaje N° 3

Avanzando más allá en la colaboración

Actividad N° 3.2

Usando Webex y APIs

Nombre del Recurso Didáctico

3.2.2 Conociendo Webex y construcción de un script

Objetivo de la Actividad

En esta actividad, usted usará las API de Webex para autenticar, administrar personas, administrar salas, administrar membresías a salas y enviar un mensaje. Después de completar esta actividad, usted será capaz de cumplir con estos objetivos:

* Conocer plataforma Webex y obtener y probar su token de acceso de Webex

* Gestionar personas en equipos de Webex

* Administrar salas en equipos de Webex

* Gestionar membresías en equipos de Webex

* Administrar mensajes en equipos de Webex

Objetivo Visual de la Actividad

La figura ilustra lo que logrará en esta actividad.

Recursos Requeridos

Estos son los recursos y equipos que se requieren para completar esta actividad:

* Computador por alumno

* Webex https://www.webex.com/downloads.html

* Python, directamente desde el Store de Microsoft en Windows

Objetivo Visual de la Actividad

La figura muestra el sitio de desarrollo webex.

Captura de pantalla de un celular con la imagen de una persona

Descripción generada automáticamente

1. Instrucciones

1. Obtener su token de acceso de Webex.

En esta parte, se registra o inicia sesión en su cuenta de Webex, explora la documentación de la API, obtiene su token de acceso y, a continuación, prueba el token de acceso que utilizará en sus llamadas a la API.

1. Iniciar sesión en Webex.

1. Vaya al sitio web del desarrollador de Webex: https://developer.webex.com/

2. Inicie sesión si ya tiene una cuenta. Si no es así, siga el proceso de registro.

2. Explorar la documentación de la API.

1. Haga clic en Documentación.

2. Webex tiene muchas API que puede usar en sus aplicaciones. Haga clic en la API Reference para expandir su submenú.

3. Explore todas las variedades de llamadas API. En este laboratorio, usará la documentación de API para Personas, Salas, Membresía y Mensaje.

3. Obtener su token de acceso.

1. Aún en Documentación, desplácese hasta el inicio, si lo haya necesario, de clic en Getting Started ubicado bajo la sección API REST.

2. En Accounts and Authentication, observe que Webex admite un token de acceso personal. Se requiere un token de autenticación para todas las llamadas a la API REST. Haga clic en el ícono Copiar en Your Personal Access Token.

Nota: Un token de acceso personal proporciona acceso a su cuenta a cualquier persona que la conozca. Asegúrese de mantenerlo en secreto.

Nota: Recibirá un mensaje indicando que el token es válido durante una cantidad de tiempo establecida, que era de 12 horas en el momento en que se escribió este laboratorio. Deberá obtener un nuevo token y actualizar sus scripts de Python si regresa a este laboratorio después de que caduque su token.

3. Copie su token de acceso personal en un archivo de texto para utilizarlo más adelante en este laboratorio.

Imagen que contiene Diagrama

Descripción generada automáticamente

2. Prueba el token de acceso.

Puede probar su token de acceso dentro de la documentación de OpenAPI en el sitio del desarrollador. Sin embargo, usará su token en scripts de Python. Por lo tanto, debe probar que funciona en un script, también.

4. Prueba su token de acceso en el sitio del desarrollador.

Puede probar su token de acceso dentro de la documentación de OpenAPI en https://developer.webex.com.

4. Vuelva a su navegador y haga clic en Documentación, si es necesario.

5. En API Reference, haga clic en People y, a continuación, haga clic en Get My Own Details.

6. En el panel Try it en el extremo derecho, observe que su token ya está listo.

7. Puede hacer clic en Try it o Run para verificar su acceso. Verá la respuesta con su información personal.

8. Haga clic en Request para ver la URL completa utilizada para enviar la solicitud GET. Usará esta URL en el siguiente paso de su script de Python.

9. En la sección central, puede revisar toda la documentación de las Response Properties.

5. Utilizar una secuencia de comandos de Python para probar su token de acceso.

1. Abra el IDLE de python. A continuación, haga clic en File > New File...

2. Pegue el script de abajo y guarde como authentciation.py.

3. Coloque el código siguiente en el archivo. Asegúrese de reemplazar su_token_aquí con su token de acceso personal que copió en el paso anterior.

Primero, dentro de la ruta de scripts de Python, debemos instalar las librerías necesarias: C:\Users\Nicolas\AppData\Local\Programs\Python\Python38-32\Scripts>

pip install requests

pip3 install simplejson

Luego le damos run para probar el script.

import requests

import json

access_token = 'su_token_here'

url = 'https://webexapis.com/v1/people/me'

headers = {

'Authorization': 'Bearer {}'.format(access_token)

}

res = requests.get(url, headers=headers)

print(json.dumps(res.json(), indent=4))

Interfaz de usuario gráfica, Texto, Aplicación, Correo electrónico

Descripción generada automáticamente

4. Guarde como archivo Python y ejecute. Debería obtener un resultado similar al de abajo.

Nota: Los valores de algunas de las claves se han truncado en la salida siguiente.

{

"id": "Y2lz... UYM2u",

"emails": [

"your-email@example.com"

],

"PhoneNumbers": [],

"displayName": "Your-First-Name Your-Last-Name",

"nickName": "Your-Nick-Name",

"firstName": " Your-First-Name",

"lastName": "Your-Last-Name",

"avatar": "https://9643-417f-9974...6baa4~1600 ",

"OrgID": "Y2lzy2... UxMgy",

"created": "2012-06-15T20:23:12.529Z",

"lastActivity": "2020-06-02T20:16:52.111Z",

"status": "active",

"type": "person"

}

Texto

Descripción generada automáticamente

3. Gestionar personas en equipos de Webex.

En Webex, las personas son usuarios registrados. A través de la API, puede recuperar una lista de personas, puede crear una persona, recuperar los detalles de una persona individual, actualizar una persona y eliminar una persona.

6. Buscar la documentación de la API para ver los detalles de un usuario registrado de Webex.

1. Vuelva al sitio web developer.webex.com. En la parte API Reference > People, haga clic en el Método de List People.

2. En Query Parameters, busque el parámetro de email. Este es el parámetro que utilizará para encontrar un usuario específico en su organización. Alternativamente, puede usar el parámetro DisplayName, si conoce el nombre exacto. Puede utilizar la función Try it.

7. Utilizar un script de Python para enumerar los detalles de un usuario registrado de Webex.

1. En Código VS, haga clic en el archivo list-people.py.

2. Coloque el código siguiente en el archivo. Asegúrese de reemplazar su_token_aquí con su token de acceso personal y el usuario @example.com por un usuario real registrado en Webex de su organización

import requests

import json

access_token = 'your_token_here'

url = 'https://webexapis.com/v1/people'

headers = {

'Authorization': 'Bearer {}'.format(access_token),

'Content-Type': 'application/json'

}

params = {

'email': 'tuusuario@ejemplo.com'

}

res = requests.get(url, headers=headers, params=params)

print(json.dumps(res.json(), indent=4))

Interfaz de usuario gráfica, Texto, Aplicación

Descripción generada automáticamente

3. Guarde y ejecute el script. Debe de obtener un resultado similar al siguiente. Si recibe un mensaje como, {'message': 'Dirección de correo electrónico no válida. '..., significa que no reemplazó el parámetro de correo electrónico vacío por una dirección de correo electrónico legítima para un usuario registrado de Webex. El valor de la clave id se utilizará en la próxima llamada a la API.

Nota: Los valores de algunas de las claves se han truncado en la salida siguiente.

...