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 dispositivos, ver información de dispositivos, automatizar flujos de trabajo de asignación de dispositivos, integrar datos de inventario de dispositivos en plataformas de terceros o crear paneles personalizados, tareas que de otro modo requerirían navegar manualmente por el portal web. 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 | Nombre del permiso | Descripción |
|---|---|---|
Dispositivos | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | Obtener una lista de los dispositivos de una organización que se inscriben mediante la inscripción automática de dispositivos. |
Dispositivos | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | 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 | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | Obtener una lista de los servicios de gestión de dispositivos de una organización. |
Servicios de gestión de dispositivos | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | 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 | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | Obtener la información del ID del servicio de gestión de dispositivos asignado a un dispositivo. |
Servicios de gestión de dispositivos | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | Obtener la información del servicio de gestión de dispositivos asignado a un dispositivo. |
Servicios de gestión de dispositivos | Ver los servicios de gestión de dispositivos, gestionar la asignación de plataforma predeterminada y añadir dispositivos con Apple Configurator. | 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 | Asignar dispositivos a los servicios de gestión de dispositivos. | Asignar o cancelar 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 | Ver esquemas. | Obtener una lista de los esquemas de una organización. |
Esquemas | Gestionar esquemas. | Crear un esquema de una organización. |
Esquemas | Gestionar esquemas. | Obtener información sobre un esquema de una organización. |
Esquemas | Gestionar esquemas. | Actualizar un esquema de una organización. |
Esquemas | Gestionar esquemas. | Eliminar un esquema de una organización. |
Esquemas | Gestionar esquemas. | Obtener o modificar los miembros de un tipo determinado dentro de un esquema de una organización. |
Configuraciones | Ver configuraciones de dispositivos. | Obtener la lista de las configuraciones de una organización. |
Configuraciones | Ver configuraciones de dispositivos. | Obtener los detalles de una configuración de una organización. |
Configuraciones | Crear, editar y eliminar configuraciones de dispositivos. | Crear una configuración de una organización (de tipo CUSTOM_SETTING). |
Configuraciones | Crear, editar y eliminar configuraciones de dispositivos. | Actualizar una configuración de una organización (de tipo CUSTOM_SETTING). |
Configuraciones | Crear, editar y eliminar configuraciones de dispositivos. | Eliminar una configuración de una organización. |
Paquetes | Ver y gestionar dispositivos mediante la gestión de dispositivos integrada. | Obtener paquetes de una organización. |
Apps | Ver apps. | Obtener las apps con licencia de una organización. |
Eventos de auditoría | Acceder a eventos de auditoría usando la API de administradores. | 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. |
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 transferida desde Apple Business Manager o Apple Business Essentials
Si tu organización se ha transferido 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:
Cambia el nombre de la cuenta
Cambia 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.
Revoca la clave privada.
Selecciona Guardar.
Consulta la documentación de Apple Developer sobre cómo gestionar la conexión.