Crear una cuenta de API en Apple Business
Información general
Con la API de Apple Business, puedes editar las asignaciones de gestión de los dispositivos y ver su información. También puedes utilizar el punto final de un dispositivo para permitir que las apps elaboren informes personalizados o exporten datos del dispositivo. La API es compatible con OAuth 2, con el que las apps pueden autenticarse mediante un conjunto de credenciales a cambio de un identificador de acceso, que sirve para realizar solicitudes autenticadas a la API.
Para poder utilizar estas API, debes crear una cuenta de API en Apple Business. Solo los usuarios con la función de Administrador de la organización pueden crear una cuenta de API.
Nota: Puedes tener hasta 50 cuentas de API.
Acceso a los datos
Si la cuenta de API está configurada correctamente, esta puede permitir que una app acceda a la siguiente información:
Categoría | Descripción |
|---|---|
Dispositivos | Obtener una lista de los dispositivos de una organización que se inscriben mediante la inscripción automática de dispositivos. |
Dispositivos | Obtener información sobre un dispositivo de una organización, como el modelo del dispositivo, el número de pedido y el número de referencia. |
Servicios de gestión de dispositivos | Obtener una lista de los servicios de gestión de dispositivos de una organización. |
Servicios de gestión de dispositivos | Obtener una lista de los números de serie de los dispositivos asignados a un servicio de gestión de dispositivos. |
Servicios de gestión de dispositivos | Obtener la información del ID del servicio de gestión de dispositivos asignado a un dispositivo. |
Servicios de gestión de dispositivos | Obtener la información del servicio de gestión de dispositivos asignado a un dispositivo. |
Servicios de gestión de dispositivos | Obtener información sobre la actividad de un dispositivo de la organización que genera una acción de gestión de dispositivos, como asignar o cancelar la asignación. |
Servicios de gestión de dispositivos | Asigna o cancela la asignación de dispositivos a un servicio de gestión de dispositivos. |
Servicios de gestión de usuarios | Obtener una lista de los usuarios de una organización. |
Servicios de gestión de usuarios | Obtener información sobre un usuario específico de una organización. |
Servicios de gestión de grupos de usuarios | Obtener una lista de los grupos de usuarios de una organización. |
Servicios de gestión de grupos de usuarios | Obtener información sobre un grupo específico de usuarios de una organización. |
Servicios de gestión de grupos de usuarios | Obtener una lista de los usuarios asignados a un grupo de usuarios de una organización. |
Esquemas | Obtener una lista de los esquemas de una organización. |
Esquemas | Crear un esquema de una organización. |
Esquemas | Obtener información sobre un esquema de una organización. |
Esquemas | Actualizar un esquema de una organización. |
Esquemas | Eliminar un esquema de una organización. |
Esquemas | Obtener o modificar los miembros de un tipo determinado dentro de un esquema de una organización. |
Configuraciones | Obtener la lista de las configuraciones de una organización. |
Configuraciones | Obtener los detalles de una configuración de una organización. |
Configuraciones | Crear una configuración de una organización (de tipo CUSTOM_SETTING). |
Configuraciones | Actualizar una configuración de una organización (de tipo CUSTOM_SETTING). |
Configuraciones | Eliminar una configuración de una organización. |
Paquetes | Obtener paquetes de una organización. |
Apps | Obtener las apps con licencia de una organización. |
Eventos de auditoría | Obtener una lista de eventos de auditoría de una organización, filtrados por distintos criterios. Un evento de auditoría representa una actividad dentro de la organización, como por ejemplo, añadir o eliminar un dispositivo. |
¿Qué permisos necesito para acceder a los puntos finales de la API?
Los usuarios con una cuenta de API necesitan los siguientes permisos para acceder a los puntos finales de la API:
Recurso | URL del recurso y permiso | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Eventos de auditoría | /v1/auditEvents CAN_ACCESS_AUDIT_EVENTS | ||||||||||
Usuarios | /v1/users Permiso implícito(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Usuarios | /v1/users/<IDENTIFIER> Permiso implícito(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Grupos de usuarios | /v1/usergroups Permiso implícito(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Grupos de usuarios | /v1/usergroups/<IDENTIFIER> Permiso implícito(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Grupos de usuarios | /v1/usergroups/<IDENTIFIER>/relationships/users Permiso implícito(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
Esquemas | /v1/blueprints CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Esquemas | /v1/blueprints/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Esquemas | /v1/blueprints/<IDENTIFIER>/relationships/<resource> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Apps | /v1/apps /v1/apps/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Paquetes | /v1/packages /v1/packages/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
Configuraciones | /v1/configurations /v1/configurations/<IDENTIFIER> CAN_VIEW_CONFIGURATIONS/CAN_MANAGE_CONFIGURATIONS | ||||||||||
Dispositivos MDM | /v1/mdmDevices /v1/mdmDevices/<IDENTIFIER>/details CAN_MANAGE_DEVICES | ||||||||||
Generar una clave privada
Para mantener una conexión segura con Apple Business, debes generar una clave privada. El nombre del archivo de la clave termina en .pem y solo se genera una vez.
Crear una cuenta de API y descargar la clave privada
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Selecciona “Añadir cuenta de la API”, escribe el nombre del usuario, selecciona su función y, a continuación, selecciona Siguiente.
Elige una de las siguientes opciones:
Selecciona “Generar y descargar” para generar y descargar la clave.
El archivo se descarga automáticamente en la ubicación de descarga de archivos establecida en las preferencias del navegador. Si no se ha indicado la ubicación, el sistema preguntará dónde guardar el archivo.
Selecciona “Ahora no” para generar la clave privada más adelante.
Selecciona Editar para ver la información que necesitas para crear la conexión.
Revisa la documentación de Apple Developer sobre cómo crear la conexión.
Editar una cuenta de API existente migrada desde Apple Business Manager o Apple Business Essentials
Si tu organización ha migrado de Apple Business Manager o Apple Business Essentials a Apple Business y tenías cuentas de API existentes, esas cuentas ahora tienen una función personalizada. Puedes revisar y editar la información de cualquier cuenta de API.
En Apple Business, inicia sesión con un usuario que tenga la función de Administrador de la organización.
Selecciona Editar junto a una cuenta de API existente.
Si es necesario, realiza una de estas acciones:
Cambiar el nombre de la cuenta
Cambiar la función
La función personalizada es Gestor de API de dispositivos. Para editar los permisos de la función, consulta Introducción a funciones y permisos.
Copia el ID de cliente en el portapapeles.
Copia el ID de clave en el portapapeles.
Anular la clave privada.
Selecciona Guardar.
Consulta la documentación de Apple Developer sobre cómo gestionar la conexión.