Usar la funcionalidad de UEM con una REST API

Puede configurar aplicaciones externas para que utilicen la funcionalidad de producto principal de Workspace ONE UEM mediante la integración de las REST API con la infraestructura de UEM y facilitar la conectividad. También puede seleccionar una URL de token de OAuth más cercana al centro de datos para autenticar las llamadas de API.

Primeros pasos con las REST API

Al utilizar la arquitectura de software REST simplificada, las REST API de Workspace ONE UEM actualmente son compatibles con varias funcionalidades, entre las que se incluyen grupo organizativo, administración de Console, aplicación móvil, dispositivo móvil, correo electrónico, usuario de inscripción, perfil, grupo inteligente y administración de grupo de usuarios.

El uso de las API basadas en REST ofrece varias ventajas a las empresas, entre las que destacan la eliminación de costes y de tiempo invertidos en el desarrollo de aplicaciones internas. Las REST API de Workspace ONE UEM están totalmente disponibles para integrarse con servidores, programas y procesos empresariales. Las REST API de Workspace ONE UEM son más eficientes, pueden funcionar sin problemas y se pueden personalizar fácilmente con las marcas de las empresas. Estas API son para desarrolladores de aplicaciones. Esta guía proporciona conocimientos sobre el diseño y la arquitectura de la biblioteca de API y facilita el desarrollo personalizado y la integración con Workspace ONE UEM.

Acceder a la documentación de la API

Para revisar la documentación detallada de la API, vaya a la página de ayuda de la API de Workspace ONE UEM.

1. Inicie sesión en Workspace ONE UEM Console como administrador.
2. En la barra de direcciones del navegador, reemplace "cn" en la URL por "as" y, a continuación, agregue /api/help después de .com.

Por ejemplo, la documentación de la API para la URL de un entorno SaaS de...

https://cn4855.awmdm.com

...es...

https://as4855.awmdm.com/api/help

URL para centro de datos y token para la compatibilidad con OAuth 2.0

Workspace ONE UEM es compatible con el protocolo estándar del sector OAuth 2.0 para la autenticación y la autorización seguras de llamadas REST API. El servicio de token de Workspace ONE es el emisor de tokens para la autenticación de OAuth y solo se admite en entornos de SaaS. Las URL del token son específicas de cada región.

Crear un cliente de OAuth para usarlo con comandos de API (SaaS)

Puede crear un cliente de OAuth para utilizarlo con comandos de API y que solo sea compatible en entornos de SaaS. Cree un cliente de OAuth para su entorno de SaaS siguiendo estos pasos.

1. Acceda a Grupos y ajustes > Configuraciones.

2. Introduzca OAuth en el cuadro de texto de búsqueda con la etiqueta "Introducir un nombre o una categoría".

3. Seleccione Administración de clientes OAuth en los resultados. Se mostrará la pantalla Administración de clientes OAuth.

4. Seleccione el botón Agregar.

5. Introduzca el Nombre, la Descripción, el Grupo organizativo y la Función.

   Note: Para obtener más información sobre los permisos específicos de REST API para la función que seleccione, consulte la sección de este tema titulada Crear una función que pueda utilizar REST API.

6. Asegúrese de que el Estado se haya establecido en Habilitado.

7. Seleccione Guardar.

8. IMPORTANTE: Copie el ID de cliente y el Secreto de cliente en el portapapeles y guárdelos antes de cerrar esta pantalla. Seleccione el icono Copiar () para enviar el Secreto de cliente al portapapeles.

   No puede volver aquí para recuperar estos datos después de seleccionar Cerrar.

9. Use el ID de cliente, el secreto de cliente y la URL del token para generar el token de acceso en el siguiente formato:

   SOLICITUD HTTP

   Llamada a API: POST {Region-Specific Token URL from section above}

   PARÁMETROS DE ENTRADA

   Parámetro	Obligatorio	Descripción
   tenant_url	Sí (URL)	Nombre de host del inquilino
   grant_type=client_credentials	Sí (cuerpo)	Requerido para recibir el token de acceso
   application/x-www-form-urlencoded	Sí (encabezado)	Formato de la codificación
   Autorización: básica	Sí (encabezado)	Debe transferir la cadena codificada en formato Base64 del client_id:Client_secret

10. Use el token de acceso devuelto para autorizar futuras solicitudes de API a los servidores de API de Workspace ONE UEM. Debe formatear el token de acceso en los encabezados de solicitud de la siguiente manera.

    Llamada a API: {UEM API}

    Clave	Valor
    Autorización	{Token de acceso}

Crear una función que pueda utilizar REST API

Cada llamada a API tiene un recurso (o permiso) correspondiente que debe incluir en la función que asigne al cliente de OAuth. Por lo tanto, los permisos que se deben incluir en la función que asigne se alinean con los tipos de llamadas a API que está realizando.

Utilice la información de la siguiente tabla para seleccionar los permisos que debe incluir en la función que asigne. A continuación, visite la sección titulada Cómo crear funciones administrativas en Acceso basado en funciones para obtener instrucciones sobre cómo crear esa función.