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.
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.
| Región | Ubicación del centro de datos de SaaS de Workspace ONE UEM | URL de token |
|---|---|---|
| Ohio (Estados Unidos) | Todo el entorno de UAT | https://uat.uemauth.vmwservices.com/connect/token |
| Virginia (Estados Unidos) | Estados Unidos | https://na.uemauth.vmwservices.com/connect/token |
| Virginia (Estados Unidos) | Canadá | https://na.uemauth.vmwservices.com/connect/token |
| Frankfurt (Alemania) | Reino Unido | https://emea.uemauth.vmwservices.com/connect/token |
| Frankfurt (Alemania) | Alemania | https://emea.uemauth.vmwservices.com/connect/token |
| Tokio (Japón) | India | https://apac.uemauth.vmwservices.com/connect/token |
| Tokio (Japón) | Japón | https://apac.uemauth.vmwservices.com/connect/token |
| Tokio (Japón) | Singapur | https://apac.uemauth.vmwservices.com/connect/token |
| Tokio (Japón) | Australia | https://apac.uemauth.vmwservices.com/connect/token |
| Tokio (Japón) | Hong Kong | https://apac.uemauth.vmwservices.com/connect/token |
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.
- Vaya a Grupos y ajustes > Configuraciones.
- Introduzca
OAuthen el cuadro de texto de búsqueda con la etiqueta "Introducir un nombre o una categoría". - Seleccione Administración de clientes OAuth en los resultados. Se mostrará la pantalla Administración de clientes OAuth.
- Seleccione el botón de Agregar.
-
Introduzca el Nombre, la Descripción, el Grupo organizativo y la Función.
Aviso: 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 puedan utilizar las REST API.
-
Asegúrese de que el Estado se haya establecido en Habilitado.
- Seleccione Guardar.
-
AVISO 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.
-
Use el ID de cliente, el secreto de cliente y la URL del token para generar el token de acceso en el siguiente formato:
Llamada API: POST {URL de token específica según la región de la sección anterior}
Clave Valor grant_type client_credentials client_id {ID de CLIENTE generado en UEM Console} client_secret {CLIENT SECRET generated on UEM console} -
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 API: {API de UEM}
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.
| Categoría | Nombre | Descripción | Solo lectura / Editar |
|---|---|---|---|
| REST > Administradores | Grupos de sistemas de API de REST | Acceso a la información del grupo de la organización | Editar |
| Administrador del sistema de API de REST | Acceso a la información del administrador | Editar | |
| Usuarios del sistema API REST | Acceso a la información del usuario | Editar | |
| Escribir API de REST - Administradores | Habilita el acceso a todas las API de escritura/actualización del conjunto de usuarios administrativos | Editar | |
| Ejecutar API de REST - Administradores | Habilita el acceso a todas las API de ejecución del conjunto de usuarios administrativos | Editar | |
| Eliminar API de REST - Administradores | Habilita el acceso a todas las API de eliminación del conjunto de usuarios administrativos | Editar | |
| Leer API de REST - Administradores | Habilita el acceso a todas las API de solo LECTURA del conjunto de usuarios administrativos | Sólo lectura | |
| REST > Aplicaciones | Blob MAM de API de REST | Subir contenido de descarga | Editar |
| Aplicaciones MAM de API de REST | Acceso a aplicaciones administradas | Editar | |
| Escribir API de REST - Aplicaciones | Habilita el acceso a todas las API de escritura/actualización del conjunto de aplicaciones | Editar | |
| Ejecutar API de REST - Aplicaciones | Habilita el acceso a todas las API de ejecución del conjunto de aplicaciones | Editar | |
| Eliminar API de REST - Aplicaciones | Habilita el acceso a todas las API de eliminación del conjunto de aplicaciones | Editar | |
| Leer API de REST - Aplicaciones | Habilita el acceso a todas las API de solo LECTURA del conjunto de aplicaciones | Sólo lectura | |
| REST > Directiva de conformidad | Eliminar política de conformidad de API de REST | Habilita el acceso para las API de Eliminar en el conjunto de políticas de conformidad | Editar |
| Ejecutar política de conformidad de API de REST | Habilita el acceso para las API de Ejecutar en el conjunto de políticas de conformidad | Editar | |
| Escribir política de conformidad de API de REST | Habilita el acceso a las API de Escritura en el conjunto de políticas de conformidad | Editar | |
| Leer política de conformidad de API de REST | Habilita el acceso a las API de solo LECTURA en el conjunto de políticas de conformidad | Sólo lectura | |
| REST > Atributos personalizados | Ejecutar atributos personalizados de API de REST | Habilita el acceso para todas las API de Ejecución en el conjunto de atributos personalizados | Editar |
| Escribir atributos personalizados de API de REST | Habilita el acceso para todas las API de Escritura en el conjunto de atributos personalizados | Editar | |
| Eliminar atributos personalizados de API de REST | Habilita el acceso para todas las API de Eliminación en el conjunto de atributos personalizados | Editar | |
| Leer atributos personalizados API de REST | Habilita el acceso a todas las API de solo lectura en el conjunto de atributos personalizados | Sólo lectura | |
| REST > Dispositivos | API de REST - Grupos inteligentes de MDM | Acceso a la información del grupo inteligente | Editar |
| API de REST - Grupos de usuarios de MDM | Acceso a grupos de usuarios | Editar | |
| API de REST - Perfiles de MDM | Enviar comandos de bloqueo/desbloqueo | Editar | |
| API de REST - Dispositivos MDM | Enviar comandos de bloqueo/desbloqueo | Editar | |
| Escribir BLOBS de API de REST | Habilita acceso a todos los APIs de escribir/actualizar en la colección de BLOBS | Editar | |
| Ejecutar BLOBS de API de REST | Habilita acceso a todos los APIs de ejecución en la colección de BLOBS | Editar | |
| Eliminar BLOBS de API de REST | Habilita acceso a todos los APIs de eliminación en la colección de BLOBS | Editar | |
| Escribir API de REST - Dispositivos | Habilita el acceso a todas las API de escritura/actualización del conjunto de dispositivos | Editar | |
| Ejecutar API de REST - Dispositivos | Habilita el acceso a todas las API de ejecución del conjunto de dispositivos | Editar | |
| Eliminar API de REST - Dispositivos | Habilita el acceso a todas las API de eliminación del conjunto de dispositivos | Editar | |
| API de REST - Dispositivos, avanzado | Habilita el acceso a todas las API avanzadas del conjunto de dispositivos | Editar | |
| Leer BLOBS de API de REST | Habilita acceso a todos los APIs de solo lectura en la colección de BLOBS | Sólo lectura | |
| Leer API de REST - Dispositivos | Habilita el acceso a todas las API de solo LECTURA del conjunto de dispositivos | Sólo lectura | |
| REST > Integración empresarial de REST | Lectura de integración empresarial de REST API | Habilita el acceso a todos los APIs de solo LECTURA en la integración empresarial | Sólo lectura |
| REST > Grupos | Escribir API de RESTT - Grupos | Habilita el acceso a todas las API de escritura/actualización de la colección de grupos de la organización | Editar |
| Ejecutar API de REST - Grupos | Habilita el acceso a todas las API de ejecución de la colección de grupos de organización | Editar | |
| Eliminar API de REST -Grupos | Habilita el acceso a todas las API de eliminación del conjunto de grupos organizativos | Editar | |
| Escribir grupos inteligentes de API de REST | Habilita el acceso a todas las API de escritura del conjunto de grupos inteligentes | Editar | |
| Ejecutar grupos inteligentes de API de REST | Habilita el acceso a todas las API de ejecución de los conjuntos de grupos inteligentes | Editar | |
| Eliminar grupos inteligentes de API de REST | Habilita el acceso a todas las API de eliminación del conjunto de grupos inteligentes | Editar | |
| Escribir grupos de usuarios de API de REST | Permite el acceso a todas las API de escritura/actualización en grupos de usuarios | Editar | |
| Ejecutar grupos de usuarios de API de REST | Permite el acceso a todas las API de ejecución en grupos de usuarios | Editar | |
| Eliminar grupos de usuarios de API de REST | Habilita el acceso a todas las API de eliminación de los grupos de usuarios | Editar | |
| API de REST de escritura del carrito | API de REST para guardar y editar los datos del carrito | Editar | |
| API de REST de eliminación del carrito | API de REST para eliminar los datos del carrito | Editar | |
| Escritura de API de REST Apple School Manager | API de REST para iniciar la sincronización de Apple School Manager | Editar | |
| API de REST de asociación de Apple School Manager | API de REST para asociar un usuario de inscripción a un miembro de Apple School Manager | Editar | |
| Guardar asignaciones de clases de API de REST | API de REST para guardar las asignaciones de la clase | Editar | |
| API de REST de escritura de la clase | API de REST para guardar y editar datos de la clase | Editar | |
| API de REST de eliminación de la clase | API de REST para borrar datos de la clase | Editar | |
| Escritura de ajustes de API de REST de Education | API de REST para guardar y editar ajustes de Educación | Editar | |
| API de REST de lectura de los ajustes de Educación | API de REST para ver la configuración de Education | Editar | |
| Leer API de REST - Grupos | Habilita el acceso a todas las API de solo LECTURA del conjunto de grupos organizativos | Sólo lectura | |
| Leer grupos inteligentes de API de REST | Habilita el acceso a todas las API de solo LECTURA del conjunto de grupos inteligentes | Sólo lectura | |
| Leer grupos de usuarios de API de REST | Habilita el acceso a todas las API de solo LECTURA de los grupos de usuarios | Sólo lectura | |
| API de REST de lectura de la sincronización de Apple School Manager | API de REST para comprobar el estado de sincronización de Apple School Manager | Sólo lectura | |
| API de REST de lectura de aplicaciones para el dispositivo | API de REST para obtener una lista de aplicaciones elegibles para el dispositivo | Sólo lectura | |
| API de REST de lectura de la clase | API de REST para ver datos de la clase | Sólo lectura | |
| REST > Productos | Ejecutar productos de API de REST | Habilita el acceso a todas las API de ejecución del conjunto de productos | Editar |
| Escribir productos API de REST | Habilita el acceso a todas las API de escritura del conjunto de productos | Editar | |
| Eliminar productos de API de REST | Habilita el acceso a todas las API de eliminación del conjunto de productos | Editar | |
| Leer productos de API de REST | Habilita el acceso a todas las API de solo LECTURA del conjunto de productos | Sólo lectura | |
| REST > Perfiles | Acceso de escritura en la política de actualizaciones | Habilita el acceso a todas las API de ESCRITURA en el conjunto de políticas de actualizaciones | Editar |
| Acceso de ejecución en la política de actualizaciones | Habilita el acceso a todas las API de EXECUTE en la colección de directivas de actualizaciones | Editar | |
| Acceso de eliminación en la política de actualizaciones | Habilita el acceso a todas las API de ELIMINACIÓN en el conjunto de políticas de actualizaciones | Editar | |
| Escribir perfiles de API de REST | Habilita el acceso a todas las API de escritura del conjunto de perfiles | Editar | |
| Ejecutar perfiles de API de REST | Habilita el acceso a todas las API de ejecución del conjunto de perfiles | Editar | |
| Eliminar perfiles de API de REST | Habilita el acceso a todas las API de eliminación del conjunto de perfiles | Editar | |
| Acceso de lectura en la política de actualizaciones | Habilita el acceso a todas las API de LECTURA en el conjunto de políticas de actualizaciones | Sólo lectura | |
| Leer perfiles de API de REST | Habilita el acceso a todas las API de solo LECTURA del conjunto de perfiles | Sólo lectura | |
| REST > Usuarios | Escribir API de REST - Usuarios | Habilita el acceso a todas las API de escritura/actualización del conjunto de usuarios de inscripción | Editar |
| Ejecutar API de REST - Usuarios | Habilita el acceso a todas las API de ejecución del conjunto de usuarios de inscripción | Editar | |
| Eliminar AAPI de REST - Usuarios | Habilita el acceso a todas las API de eliminación del conjunto de usuarios de inscripción | Editar | |
| Leer tokens de usuario de API de REST | Habilita el acceso de los tokens de inscripción de usuarios para las API en la colección de usuarios de inscripción | Sólo lectura | |
| Leer API de REST - Usuarios | Habilita el acceso a todas las API de solo LECTURA del conjunto de usuarios de inscripción | Sólo lectura |
