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).

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 inscreve um novo dispositivo Android com uma política, com seu próprio token de inscrição válido por 24 horas.

Todos os Endpoints

Método	Endpoint	Descrição
GET	/assets	Listar todos os ativos com paginação e filtros
GET	/assets/count	Obter contagem total de ativos
GET	/assets/{id}	Obter detalhes de um ativo específico
GET	/policies	Listar todas as políticas
GET	/policies/{pathName}	Obter detalhes de uma política específica
GET	/assets/summary	Obtenha números agregados da frota: totais, detalhamento de status e um resumo da postura de segurança
GET	/assets/{assetId}/commands	Listar os comandos mais recentes enviados a um dispositivo
POST	/assets/{assetId}/commands/lock	Bloqueie a tela do dispositivo imediatamente. Apenas dispositivos Android Management. Nenhum corpo de requisição.
POST	/assets/{assetId}/commands/lost-mode	Bloqueie o dispositivo e exiba uma mensagem, com detalhes de contato opcionais, na tela de bloqueio. Apenas dispositivos Android Management.
POST	/assets/{assetId}/commands/found	Encerre 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/message	Exiba uma notificação push em texto sem formatação no dispositivo.
POST	/assets/{assetId}/commands/status-report	Solicite 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-update	Solicite 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-policy	Envie 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/reboot	Reinicie 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/shutdown	Desligue 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-app	Abra um aplicativo instalado no dispositivo pelo nome do pacote. Apenas dispositivos gerenciados pelo agente Nomid (AOSP).
POST	/assets/{assetId}/commands/clear-app-data	Exclua 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-policy	Mova 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/wipe	Remova 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-lock	Remova 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-password	Defina 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/relinquish-ownership	Libere 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}/settings	As configurações editáveis da política, cada uma com seu valor atual, valores permitidos, grupo e se a alteração é de alto impacto. Também retorna policy version, deviceCount, se a política é editável e seus apps, cada um com packageName, name, source, installType e managedByNomid, que é true para os apps que não podem ser alterados aqui.
GET	/policies/{policyId}/document	A 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}/revisions	As 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}/changes	Propõe alterações de configurações em uma política existente. Retorna 201 com a proposta.
POST	/policies/{policyId}/app-changes	Proponha 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}/edits	Proponha 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	Proponha 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}/rollbacks	Propõe restaurar a política para uma revisão anterior. Retorna 201 com a proposta.
POST	/policy-proposals/{proposalId}/apply	Aplica uma proposta pendente. Retorna 200 com a proposta e seu resultado: policyId, displayName, version e um link do portal.
POST	/policies/{policyId}/provisioning-qr-codes	Criar um código QR de provisionamento para uma política, com um novo token de inscriçã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