Autenticação

A API Nomid MDM usa chaves de API para autenticar solicitações. Este guia explica como obter e usar sua chave de API.

Visão Geral

As chaves de API são usadas para autenticar todas as solicitações à API Nomid MDM. Inclua sua chave de API no cabeçalho X-API-Key com cada solicitação.

X-API-Key: nm_acme_a1b2c3d4e5f6...

Obtendo Sua Chave de API

As chaves de API são criadas e gerenciadas através do Portal Nomid. Siga estes passos para criar sua primeira chave de API.

Pré-requisitos

Uma conta Nomid MDM com acesso de administrador
Acesso às Configurações da Empresa no Portal Nomid

1
Acesse o Portal Nomid
Abra seu navegador e acesse o Portal Nomid. Entre com suas credenciais de administrador.
2
Navegue até Integrações
Após fazer login, vá para a seção Configurações da Empresa e selecione a aba Integrações.
3
Clique em Criar Chave de API
Clique no botão "Criar Chave de API" localizado no canto superior direito da página de Integrações.
4
Digite um Nome
No modal que aparece, digite um nome descritivo para sua chave de API. Isso ajuda a identificar a chave posteriormente (ex.: "Integração Power BI" ou "Sincronização CRM").
5
Copie Sua Chave
Após clicar em Criar, sua chave de API será exibida. Clique no botão copiar para copiá-la para a área de transferência. A chave será exibida apenas uma vez!

Formato da Chave de API

As chaves de API seguem este formato:

nm_{company}_{random_32_chars}

Todas as chaves começam com 'nm_'
Prefixo específico da empresa para identificação
32 caracteres aleatórios para segurança

Usando Sua Chave de API

Inclua a chave de API no cabeçalho X-API-Key com cada solicitação:

curl -X GET "https://api.nomid.tech/emm/api/v1/assets" \
  -H "X-API-Key: nm_acme_a1b2c3d4e5f6..."

Permissões da chave de API

Cada chave possui as permissões que você escolher ao criá-la. Um endpoint retorna 403 se a chave não tiver a permissão necessária. O servidor MCP retorna um erro de ferramenta em vez disso.

Permissão	Descrição
DEVICES_READ	Listar e ler dispositivos, o resumo da frota e o histórico de comandos. Obrigatório para os endpoints GET /assets, a API de BI e as ferramentas MCP de leitura de dispositivos.
POLICIES_READ	Listar e ler políticas. Obrigatório para GET /policies, GET /policies/POLICY_ID e as ferramentas de políticas do MCP.
DEVICES_COMMAND	Enviar um comando para um dispositivo: bloquear, modo perdido, mensagem, relatório de status, atualização de localização, sincronização de políticas, reiniciar, desligar, iniciar aplicativo, limpar dados do aplicativo e alterar política (que também requer POLICIES_READ). Opcional (opt-in) e nunca implícito por outra permissão. Deve ser combinado com DEVICES_READ. Obrigatório para os endpoints POST de comando padrão e as ferramentas de comando MCP.
DEVICES_COMMAND_DESTRUCTIVE	Execute comandos destrutivos em um dispositivo: limpar, redefinir ou alterar o bloqueio de tela e renunciar à propriedade. Eles são executados imediatamente, sem etapa de aprovação no portal. Opcional (opt-in), separado de DEVICES_COMMAND, e deve ser combinado com DEVICES_READ. A empresa também deve ativar comandos destrutivos no acesso de agente de IA no portal. Obrigatório para os quatro endpoints de comandos destrutivos e as ferramentas de comandos destrutivos do MCP.
PROVISIONING	Crie códigos QR de provisionamento para as políticas da empresa. Cada código QR contém um novo token de inscrição que expira após 24 horas. Opcional (opt-in), e deve ser combinado com POLICIES_READ. Somente um usuário do portal que tem permissão para provisionar dispositivos e possui acesso a todas as políticas pode criar uma chave com ele. Obrigatório para POST /policies/POLICY_ID/provisioning-qr-codes e a ferramenta MCP create_provisioning_qr_code. API de códigos QR de provisionamento
EXPORT_READ	Permissão legada. Nenhum endpoint ou ferramenta a verifica, e novas chaves não podem mais ser criadas com ela.
POLICIES_WRITE	Uma chave de API com a permissão POLICIES_WRITE (Alterações de política), combinada com POLICIES_READ. Apenas um usuário do portal com permissão para editar políticas pode criar uma chave com POLICIES_WRITE. Necessário para os seis endpoints POST e para as ferramentas de alteração de política MCP. API de alterações de política

Onde enviar a chave

A API REST aceita a chave somente no cabeçalho X-API-Key. O endpoint MCP aceita X-API-Key ou Authorization: Bearer seguido pela chave.

Guia do servidor MCP

Limites de taxa e cabeçalhos

Os endpoints de leitura REST não aplicam um limite por chave no aplicativo Nomid, mas programe seu cliente para aguardar (backoff) em caso de 429 de qualquer maneira. O endpoint MCP permite 60 solicitações por minuto por chave. Comandos de dispositivo, alterações de política (cada chamada de propose e apply) e códigos QR de provisionamento compartilham um limite de gravação de 10 solicitações por minuto por chave, somando REST e MCP. Uma conexão Sign in with Nomid possui os mesmos limites de MCP e de gravação, contabilizados por conexão.

Uma resposta HTTP 429 inclui um cabeçalho Retry-After com os segundos a aguardar. Quando uma chamada de comando MCP, alteração de política ou ferramenta de provisionamento excede o limite de gravação, o texto de erro da ferramenta informa os segundos. A API não define os cabeçalhos X-RateLimit-Limit, X-RateLimit-Remaining ou X-RateLimit-Reset.

Melhores Práticas de Segurança

Nunca exponha chaves de API em código do lado do cliente ou repositórios públicos
Rotacione chaves regularmente e revogue chaves não utilizadas
Armazene chaves em variáveis de ambiente, não no código
Use as permissões mínimas necessárias para sua integração

Erros de Autenticação

A API retorna códigos de erro específicos para problemas de autenticação:

Código de Status	Descrição
401	Chave de API ausente ou inválida
403	Chave de API não tem as permissões necessárias
429	Limite de taxa excedido