Referência da API

Documentação de referência completa para a API Externa do Nomid MDM. Encontre informações detalhadas sobre endpoints, parâmetros e formatos de resposta.

URL Base

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

Seções da Documentação

Autenticação

Aprenda a autenticar suas solicitações de API usando chaves de API.

Ativos

Endpoints para listar, filtrar e obter informações de ativos.

Políticas

Endpoints para acessar dados de políticas e atribuições de dispositivos.

Erros

Entendendo respostas de erro e códigos de status.

Integração BI

Exportações de dados simplificados para ferramentas de Business Intelligence.

API de comandos de dispositivo

Envie um comando para um dispositivo por vez com uma chamada REST, desde bloqueio, reinicialização e mensagens até comandos destrutivos, como formatação (wipe).

API de alterações de política

Altere configurações de políticas, apps, redes Wi-Fi e muito mais, crie uma política do zero ou como uma cópia, ou reverta uma política, com uma etapa de revisão antes que qualquer coisa seja aplicada.

API de códigos QR de provisionamento

Crie um código QR que registra um novo dispositivo Android com uma política, com seu próprio token de registro válido por 24 horas.

API de uploads de APK

Publique versões de APK assinadas na biblioteca da sua empresa a partir de um pipeline de CI, com uma chave de API restrita à empresa.

API de aplicativos da biblioteca

Leia e gerencie os aplicativos da biblioteca da empresa, versões de APK, ícones, categorias e tracks com uma chave de API restrita à empresa.

API de sessões de Device User

Informe os logins e logouts de usuários que seu próprio aplicativo autentica em um dispositivo gerenciado e consulte quem usou qual dispositivo e quando.

Todos os Endpoints

MétodoEndpointDescrição
GET/assetsListar todos os ativos com paginação e filtros
GET/assets/countObter contagem total de ativos
GET/assets/{id}Obter detalhes de um ativo específico
GET/policiesListar todas as políticas
GET/policies/{pathName}Obter detalhes de uma política específica
GET/assets/summaryObtenha números agregados da frota: totais, detalhamento de status e um resumo da postura de segurança
GET/assets/{assetId}/commandsListar os comandos mais recentes enviados a um dispositivo
POST/assets/{assetId}/commands/lockBloqueie a tela do dispositivo imediatamente. Apenas dispositivos Android Management. Nenhum corpo de requisição.
POST/assets/{assetId}/commands/lost-modeBloqueie o dispositivo e exiba uma mensagem, com detalhes de contato opcionais, na tela de bloqueio. Apenas dispositivos Android Management.
POST/assets/{assetId}/commands/foundEncerre o modo perdido. Nada acontece e nenhum erro é retornado se o dispositivo não estiver no modo perdido. Apenas dispositivos Android Management. Nenhum corpo de requisição.
POST/assets/{assetId}/commands/messageExiba uma notificação push em texto sem formatação no dispositivo.
POST/assets/{assetId}/commands/status-reportSolicite ao dispositivo que envie um relatório de status atualizado agora. O relatório chega mais tarde: leia-o com GET /assets/ASSET_ID. Sem corpo da solicitação.
POST/assets/{assetId}/commands/location-updateSolicite ao dispositivo que informe sua localização atual agora. A localização chega mais tarde: leia-a com GET /assets/ASSET_ID. Sem corpo da solicitação.
POST/assets/{assetId}/commands/sync-policyEnvie a política atual para o dispositivo novamente. Apenas dispositivos gerenciados pelo agente Nomid (AOSP): dispositivos Android Management recebem alterações de política automaticamente e respondem com 409. Sem corpo da solicitação.
POST/assets/{assetId}/commands/rebootReinicie o dispositivo agora. Quem estiver usando o dispositivo será interrompido e o trabalho não salvo poderá ser perdido. Sem corpo da solicitação.
POST/assets/{assetId}/commands/shutdownDesligue o dispositivo agora. Ele não pode ser ligado novamente de forma remota. Apenas dispositivos gerenciados pelo agente Nomid (AOSP). Sem corpo da solicitação.
POST/assets/{assetId}/commands/launch-appAbra um aplicativo instalado no dispositivo pelo nome do pacote. Apenas dispositivos gerenciados pelo agente Nomid (AOSP).
POST/assets/{assetId}/commands/clear-app-dataExclua todos os dados dos aplicativos especificados (contas, configurações e arquivos), como se tivessem acabado de ser instalados. Isso não pode ser desfeito. Apenas dispositivos Android Management.
POST/assets/{assetId}/commands/change-policyMova o dispositivo para outra política da empresa. O dispositivo aplica os aplicativos, restrições e configurações da nova política, e tudo o que apenas a política atual possuía é removido. Também requer POLICIES_READ.
POST/assets/{assetId}/commands/wipeRemova o dispositivo do gerenciamento e apague seus dados gerenciados. Um dispositivo de propriedade da empresa é restaurado para as configurações de fábrica: todos os aplicativos e dados nele são apagados. Em um dispositivo de propriedade pessoal com perfil de trabalho, apenas o perfil de trabalho e seus aplicativos e dados são removidos; os aplicativos e dados pessoais permanecem. Irreversível. Sem corpo da solicitação.
POST/assets/{assetId}/commands/reset-screen-lockRemova o bloqueio de tela do dispositivo (PIN, padrão ou senha), para que ele possa ser desbloqueado sem um. Apenas dispositivos Android Management. Sem corpo da solicitação.
POST/assets/{assetId}/commands/change-screen-lock-passwordDefina uma nova senha de bloqueio de tela. O dispositivo é bloqueado e apenas a nova senha o desbloqueia. Apenas dispositivos Android Management.
POST/assets/{assetId}/commands/uninstall-appsDesinstale os aplicativos especificados e todos os dados deles do dispositivo. Apenas dispositivos gerenciados pelo agente Nomid (AOSP), versão 4.5.20 ou posterior: dispositivos Android Management respondem 409, e um agente mais antigo registra o comando como falho. O dispositivo o executa na próxima vez que fizer check-in, mesmo dias depois. Um aplicativo que a política do dispositivo ainda instala volta na próxima sincronização da política; para mantê-lo fora, bloqueie-o na política.
POST/assets/{assetId}/commands/relinquish-ownershipLibere um dispositivo de propriedade da empresa para o seu usuário. O perfil de trabalho e seus dados são removidos, e o dispositivo não é mais gerenciado. Irreversível. Sem corpo da solicitação.
GET/policies/{policyId}/settingsAs configurações editáveis da política, cada uma com seu valor atual, os valores permitidos, o grupo e se está marcada como de alto impacto, o que torna a alteração HIGH a partir de 1 dispositivo. Também retorna a versão da política, deviceCount, se a política é editável e seus aplicativos, cada um com packageName, name, source, installType e managedByNomid, que é true para os aplicativos que não podem ser alterados aqui.
GET/policies/{policyId}/documentA configuração completa da política como JSON em value, ou apenas a parte em path, um JSON Pointer como /openNetworkConfigurations. Um app é referenciado pelo nome do pacote, como em /apps/com.example.app. Segredos retornam como um marcador, um objeto com redacted definido como true, assim como todo valor da configuração gerenciada de um app. Sem path, os apps são resumidos com packageName, name, source, installType e managedConfigurationKeys. Também retorna policyId, displayName, version, deviceCount, editable e lockedFields, os campos que o endpoint de edições recusa, cada um com o motivo. Uma parte com mais de 30000 caracteres retorna fieldSizes em vez de value: leia um path mais restrito. Retorna 422 quando path nomeia um app que a política não possui.
GET/policies/{policyId}/revisionsAs revisões salvas da política, da mais recente para a mais antiga, com quando e por quem cada uma foi salva. limit é opcional, de 1 a 100, padrão 20.
GET/policy-proposals/{proposalId}Uma proposta feita por esta chave, com sua lista de alterações e status: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED ou EXPIRED.
POST/policies/{policyId}/changesPropõe alterações de configurações em uma política existente. Retorna 201 com a proposta.
POST/policies/{policyId}/app-changesProponha a adição de apps a uma política existente, a remoção deles ou a alteração de como são instalados. Retorna 201 com a proposta.
POST/policies/{policyId}/editsProponha alterações a qualquer parte editável de uma política existente, como edições de JSON Pointer de seu documento. Retorna 201 com a proposta.
POST/policies/{policyId}/home-screenPropõe uma alteração na tela inicial da política: a tela inicial do próprio dispositivo, o launcher do Nomid ou o Nomid Kiosk, com o dock do launcher e os apps que ele mostra. Retorna 201 com a proposta.
POST/policies/{policyId}/detailsPropõe uma alteração na descrição, nas tags ou no grupo da política. Os dispositivos não são afetados, portanto nunca é de impacto HIGH. Retorna 201 com a proposta.
POST/policiesProponha uma nova política, com alterações opcionais de configurações. Com fromPolicyId, é uma cópia dessa política e, sem alterações, uma duplicata. Sem fromPolicyId, começa a partir dos padrões do Nomid. Retorna 201 com a proposta.
POST/policies/{policyId}/rollbacksPropõe restaurar a política para uma revisão anterior. Retorna 201 com a proposta.
POST/policy-proposals/{proposalId}/applyAplica uma proposta pendente. Retorna 200 com a proposta e seu resultado: policyId, displayName, version e um link do portal.
POST/policies/{policyId}/provisioning-qr-codesCriar um código QR de provisionamento para uma política, com um novo token de registro
POST/library/apps/uploads/checkVerifique a elegibilidade, o conteúdo duplicado e uma sessão retomável existente. Uma duplicata é apenas informativa.
POST/library/apps/uploads/startInicie um upload e receba sessionId, partSize e expiresAt.
POST/library/apps/uploads/parts/signObtenha uma URL PUT direta para o S3, de curta duração, e requiredHeaders para uma parte.
GET/library/apps/uploads/parts/{sessionId}Liste as partes já enviadas que podem ser reutilizadas e seus ETags exatos para a mesma sessão.
POST/library/apps/uploads/completeEnvie a lista ordenada de partes e, opcionalmente, as tracks para montar e processar o APK.
GET/library/apps/uploads/status/{sessionId}Consulte a sessão até que status seja completed ou failed.
DELETE/library/apps/uploads/abort/{sessionId}Cancele uma sessão não finalizada; sessões em processamento ou concluídas não podem ser canceladas.
GET/library/apps/{packageName}/versions/{versionCode}/check-reportLeia o relatório de verificação de upload mais recente de uma versão. Ele exige packageName e versionCode da versão e o ambiente dela, quando este não estiver vazio.
GET/library/appsLista os aplicativos visíveis em páginas; includeHidden pode incluir os aplicativos ocultos.
GET/library/apps/{packageName}Obtém um aplicativo, inclusive quando estiver oculto.
GET/library/apps/{packageName}/versionsLista as versões; includeHidden pode incluir as versões ocultas.
GET/library/apps/{packageName}/versions/{versionCode}Obtém uma versão, inclusive quando estiver oculta. Informe o environment dela quando não estiver vazio.
PATCH/library/apps/{packageName}/display-nameDefine um nome de exibição ou o redefine para o nome do APK.
PATCH/library/apps/{packageName}/categoriesSubstitui os rótulos de categoria do aplicativo.
POST/library/apps/{packageName}/iconEnvia um ícone como multipart form-data usando o campo file.
DELETE/library/apps/{packageName}/iconRemove o ícone personalizado.
DELETE/library/apps/{packageName}Oculta um aplicativo existente; retorna 204 e não o exclui fisicamente.
POST/library/apps/{packageName}/publishRestaura um aplicativo de forma idempotente; retorna o aplicativo.
DELETE/library/apps/{packageName}/versions/{versionCode}Oculta uma versão existente; retorna 204. Se for a última versão publicada, o aplicativo fica oculto, mas essa versão continua publicada para permitir a restauração. Informe o environment dela quando não estiver vazio.
POST/library/apps/{packageName}/versions/{versionCode}/publishRestaura uma versão e, quando necessário, o aplicativo dela. Informe o environment dela quando não estiver vazio.
GET/library/apps/{packageName}/tracksLista a última versão publicada de cada track de um aplicativo publicado. Com códigos de versão iguais, prevalece o environment mais alto em ordem lexicográfica.
PUT/library/apps/{packageName}/versions/{versionCode}/tracks/{trackName}Atribui uma versão publicada a um track; retorna a atribuição. Informe o environment dela quando não estiver vazio.
DELETE/library/apps/{packageName}/versions/{versionCode}/tracks/{trackName}Remove a atribuição de um track; retorna 204. Informe o environment dela quando não estiver vazio.
GET/device-user-loginsListar sessões de Device User, da mais recente para a mais antiga, com filtros opcionais
POST/device-user-loginsRelatar que um usuário autenticado pelo seu sistema fez login em um dispositivo; retorna 201 com a sessão
POST/device-user-logins/logoutRelatar um logout, por loginId ou por dispositivo e usuário; retorna as sessões em questão

Tipos de Conteúdo

Todas as solicitações e respostas usam formato JSON. Configure o cabeçalho Content-Type adequadamente.

Content-Type: application/json

Escolha o seu horário

Carregando...
Abrir calendário de agendamento