Referencia de API

Documentación de referencia completa para la API Externa de Nomid MDM. Encuentra información detallada sobre endpoints, parámetros y formatos de respuesta.

URL Base

https://api.nomid.tech/emm/api/v1

Secciones de Documentación

Autenticación

Aprende a autenticar tus solicitudes de API usando claves API.

Activos

Endpoints para listar, filtrar y obtener información de activos.

Políticas

Endpoints para acceder a datos de políticas y asignaciones de dispositivos.

Errores

Entendiendo respuestas de error y códigos de estado.

Integración BI

Exportaciones de datos aplanados para herramientas de Business Intelligence.

API de comandos de dispositivos

Envíe un comando a un dispositivo a la vez con una llamada REST, desde bloqueo, reinicio y mensajes hasta comandos destructivos como el borrado.

API de cambios de políticas

Cambie la configuración de las políticas, aplicaciones, redes Wi-Fi y más, cree una política desde cero o como una copia, o revierta una, con un paso de revisión antes de aplicar cualquier cambio.

API de códigos QR de aprovisionamiento

Crea un código QR que inscribe un nuevo dispositivo Android con una política, con su propio token de inscripción válido por 24 horas.

API de cargas de APK

Publique versiones firmadas de APK en la biblioteca de su empresa desde un pipeline de CI con una clave de API limitada a la empresa.

API de aplicaciones de la biblioteca

Lea y administre las aplicaciones de la biblioteca de la empresa, las versiones de APK, los iconos, las categorías y los tracks con una clave de API limitada a la empresa.

API de sesiones de usuarios de dispositivos

Reporte los inicios y cierres de sesión de los usuarios que su propia aplicación autentica en un dispositivo administrado, y consulte quién utilizó qué dispositivo y cuándo.

Todos los Endpoints

MétodoEndpointDescripción
GET/assetsListar todos los activos con paginación y filtros
GET/assets/countObtener el conteo total de activos
GET/assets/{id}Obtener detalles de un activo específico
GET/policiesListar todas las políticas
GET/policies/{pathName}Obtener detalles de una política específica
GET/assets/summaryObtenga cifras agregadas de la flota: totales, un desglose de estado y un resumen de la postura de seguridad
GET/assets/{assetId}/commandsListar los comandos más recientes enviados a un dispositivo
POST/assets/{assetId}/commands/lockBloquea la pantalla del dispositivo de inmediato. Solo dispositivos Android Management. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/lost-modeBloquea el dispositivo y muestra un mensaje, con detalles de contacto opcionales, en su pantalla de bloqueo. Solo dispositivos Android Management.
POST/assets/{assetId}/commands/foundFinaliza el modo perdido. No ocurre nada y no se devuelve ningún error si el dispositivo no estaba en modo perdido. Solo dispositivos Android Management. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/messageMuestra una notificación push de texto sin formato en el dispositivo.
POST/assets/{assetId}/commands/status-reportSolicita al dispositivo que envíe un informe de estado actualizado ahora. El informe llega más tarde: léelo con GET /assets/ASSET_ID. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/location-updateSolicita al dispositivo que informe su ubicación actual ahora. La ubicación llega más tarde: léela con GET /assets/ASSET_ID. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/sync-policyVuelve a enviar al dispositivo su política actual. Solo dispositivos administrados por el agente de Nomid (AOSP): los dispositivos de Android Management reciben cambios de política automáticamente y responden 409. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/rebootReinicia el dispositivo ahora. Quienquiera que lo esté usando será interrumpido y el trabajo no guardado podría perderse. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/shutdownApaga el dispositivo ahora. No se puede volver a encender de forma remota. Solo dispositivos administrados por el agente de Nomid (AOSP). Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/launch-appAbre una aplicación instalada en el dispositivo por el nombre del paquete. Solo dispositivos administrados por el agente de Nomid (AOSP).
POST/assets/{assetId}/commands/clear-app-dataElimina todos los datos de las aplicaciones especificadas (cuentas, ajustes y archivos), como si acabaran de ser instaladas. No se puede deshacer. Solo dispositivos de Android Management.
POST/assets/{assetId}/commands/change-policyMueve el dispositivo a otra política de la empresa. El dispositivo aplica las aplicaciones, restricciones y ajustes de la nueva política, y se elimina todo lo que solo tenía la política actual. También requiere POLICIES_READ.
POST/assets/{assetId}/commands/wipeElimina el dispositivo de la administración y borra sus datos administrados. Un dispositivo propiedad de la empresa se restablece a los valores de fábrica: se borran todas las aplicaciones y todos los datos en él. En un dispositivo de propiedad personal con perfil de trabajo, solo se eliminan el perfil de trabajo y sus aplicaciones y datos; las aplicaciones y los datos personales se conservan. Irreversible. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/reset-screen-lockElimina el bloqueo de pantalla del dispositivo (PIN, patrón o contraseña), para que se pueda desbloquear sin uno. Solo dispositivos de Android Management. Sin cuerpo de solicitud.
POST/assets/{assetId}/commands/change-screen-lock-passwordEstablece una nueva contraseña de bloqueo de pantalla. El dispositivo se bloquea y solo la nueva contraseña lo desbloquea. Solo dispositivos de Android Management.
POST/assets/{assetId}/commands/uninstall-appsDesinstala las aplicaciones indicadas y todos sus datos del dispositivo. Solo dispositivos administrados por el agente de Nomid (AOSP), versión 4.5.20 o posterior: los dispositivos de Android Management responden 409, y un agente anterior registra el comando como fallido. El dispositivo lo ejecuta la próxima vez que se conecta, incluso días después. Una aplicación que la política del dispositivo sigue instalando vuelve en la siguiente sincronización de la política; para mantenerla fuera, bloquéela en la política.
POST/assets/{assetId}/commands/relinquish-ownershipLibera un dispositivo propiedad de la empresa a su usuario. El perfil de trabajo y sus datos se eliminan, y el dispositivo deja de estar administrado. Irreversible. Sin cuerpo de solicitud.
GET/policies/{policyId}/settingsLos ajustes editables de la política, cada uno con su valor actual, los valores permitidos, el grupo y si está marcado como de alto impacto, lo que hace que cambiarlo sea HIGH desde 1 dispositivo. También devuelve la versión de la política, deviceCount, si la política es editable y sus aplicaciones, cada una con packageName, name, source, installType y managedByNomid, que es true en las aplicaciones que no se pueden cambiar aquí.
GET/policies/{policyId}/documentLa configuración completa de la política como JSON en value, o solo la parte en path, un JSON Pointer como /openNetworkConfigurations. Una aplicación se referencia por su nombre de paquete, como en /apps/com.example.app. Los secretos se devuelven como un marcador, un objeto con redacted establecido en true, al igual que cada valor de la configuración administrada de una aplicación. Sin path, las aplicaciones se resumen con packageName, name, source, installType y managedConfigurationKeys. También devuelve policyId, displayName, version, deviceCount, editable y lockedFields, los campos que el endpoint de ediciones rechaza, cada uno con su motivo. Una parte con más de 30000 caracteres devuelve fieldSizes en lugar de value: lea una ruta más específica. Devuelve 422 cuando path nombra una aplicación que la política no contiene.
GET/policies/{policyId}/revisionsLas revisiones guardadas de la política, de la más reciente a la más antigua, con cuándo y por quién se guardó cada una. limit es opcional, de 1 a 100, por defecto 20.
GET/policy-proposals/{proposalId}Una propuesta realizada por esta clave, con su lista de cambios y estado: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED o EXPIRED.
POST/policies/{policyId}/changesProponer cambios de configuración a una política existente. Devuelve 201 con la propuesta.
POST/policies/{policyId}/app-changesProponga añadir aplicaciones a una política existente, eliminarlas o cambiar su modo de instalación. Devuelve 201 con la propuesta.
POST/policies/{policyId}/editsProponga cambios en cualquier parte editable de una política existente, como ediciones JSON Pointer de su documento. Devuelve 201 con la propuesta.
POST/policies/{policyId}/home-screenPropone un cambio en la pantalla de inicio de la política: la pantalla de inicio del propio dispositivo, el launcher de Nomid o Nomid Kiosk, con el dock del launcher y las aplicaciones que muestra. Devuelve 201 con la propuesta.
POST/policies/{policyId}/detailsPropone un cambio en la descripción, las etiquetas o el grupo de la política. No afecta a los dispositivos, por lo que nunca tiene impacto HIGH. Devuelve 201 con la propuesta.
POST/policiesProponga una nueva política, con cambios de configuración opcionales. Con fromPolicyId es una copia de dicha política, y sin cambios es un duplicado. Sin fromPolicyId comienza a partir de los valores predeterminados de Nomid. Devuelve 201 con la propuesta.
POST/policies/{policyId}/rollbacksProponer restaurar la política a una revisión anterior. Devuelve 201 con la propuesta.
POST/policy-proposals/{proposalId}/applyAplicar una propuesta pendiente. Devuelve 200 con la propuesta y su resultado: policyId, displayName, version y un enlace al portal.
POST/policies/{policyId}/provisioning-qr-codesCrea un código QR de aprovisionamiento para una política, con un nuevo token de inscripción
POST/library/apps/uploads/checkCompruebe la elegibilidad, el contenido duplicado y si existe una sesión reanudable. Un duplicado es meramente informativo.
POST/library/apps/uploads/startInicie una carga y reciba sessionId, partSize y expiresAt.
POST/library/apps/uploads/parts/signObtenga una URL PUT directa de S3 de corta duración y requiredHeaders para una parte.
GET/library/apps/uploads/parts/{sessionId}Liste las partes ya cargadas que se pueden reutilizar y sus ETags exactos para la misma sesión.
POST/library/apps/uploads/completeEnvíe la lista ordenada de partes y, opcionalmente, los canales para ensamblar y procesar el APK.
GET/library/apps/uploads/status/{sessionId}Consulte la sesión periódicamente hasta que status sea completed o failed.
DELETE/library/apps/uploads/abort/{sessionId}Cancele una sesión sin terminar; las sesiones en procesamiento o completadas no se pueden cancelar.
GET/library/apps/{packageName}/versions/{versionCode}/check-reportLea el último informe de comprobación de carga de una versión. Necesita el packageName y el versionCode de la versión y su entorno cuando este no esté vacío.
GET/library/appsLista las aplicaciones visibles por páginas; includeHidden puede incluir las aplicaciones ocultas.
GET/library/apps/{packageName}Obtiene una aplicación, también si está oculta.
GET/library/apps/{packageName}/versionsLista las versiones; includeHidden puede incluir las versiones ocultas.
GET/library/apps/{packageName}/versions/{versionCode}Obtiene una versión, también si está oculta. Indique su environment cuando no esté vacío.
PATCH/library/apps/{packageName}/display-nameEstablece un nombre visible o lo restablece al nombre del APK.
PATCH/library/apps/{packageName}/categoriesReemplaza las etiquetas de categoría de la aplicación.
POST/library/apps/{packageName}/iconCarga un icono como multipart form-data mediante el campo file.
DELETE/library/apps/{packageName}/iconElimina el icono personalizado.
DELETE/library/apps/{packageName}Oculta una aplicación existente; devuelve 204 y no la elimina físicamente.
POST/library/apps/{packageName}/publishRestaura una aplicación de forma idempotente; devuelve la aplicación.
DELETE/library/apps/{packageName}/versions/{versionCode}Oculta una versión existente; devuelve 204. Si es la última versión publicada, la aplicación pasa a estar oculta mientras esa versión permanece publicada para poder restaurarla. Indique su environment cuando no esté vacío.
POST/library/apps/{packageName}/versions/{versionCode}/publishRestaura una versión y, cuando sea necesario, su aplicación. Indique su environment cuando no esté vacío.
GET/library/apps/{packageName}/tracksLista la última versión publicada de cada track de una aplicación publicada. Si los códigos de versión son iguales, prevalece el environment más alto en orden lexicográfico.
PUT/library/apps/{packageName}/versions/{versionCode}/tracks/{trackName}Asigna una versión publicada a un track; devuelve la asignación. Indique su environment cuando no esté vacío.
DELETE/library/apps/{packageName}/versions/{versionCode}/tracks/{trackName}Elimina la asignación de un track; devuelve 204. Indique su environment cuando no esté vacío.
GET/device-user-loginsEnumera las sesiones de usuarios de dispositivos, las más recientes primero, con filtros opcionales
POST/device-user-loginsReporta que un usuario autenticado por su sistema inició sesión en un dispositivo; devuelve 201 con la sesión
POST/device-user-logins/logoutReporta un cierre de sesión, por loginId o por dispositivo y usuario; devuelve las sesiones afectadas

Tipos de Contenido

Todas las solicitudes y respuestas usan formato JSON. Configura el encabezado Content-Type apropiadamente.

Content-Type: application/json

Elija su horario

Cargando...
Abrir el calendario de reservas