Autenticação
A API Nomid MDM utiliza chaves de API para autenticar pedidos. Este guia explica como obter e utilizar a sua chave de API.
Visão Geral
As chaves de API são utilizadas para autenticar todos os pedidos para a API Nomid MDM. Inclua a sua chave de API no cabeçalho X-API-Key em cada pedido.
X-API-Key: nm_acme_a1b2c3d4e5f6... Obter a sua Chave de API
As chaves de API são criadas e geridas através do Portal Nomid. Siga estes passos para criar a sua primeira chave de API.
Pré-requisitos
- Uma conta Nomid MDM com acesso de administrador
- Acesso às Definições da Empresa no Portal Nomid
- 1
Iniciar sessão no Portal Nomid
Abra o seu navegador e navegue até ao Portal Nomid. Inicie sessão com as suas credenciais de administrador.
- 2
Navegar para Integrações
Após iniciar sessão, aceda à secção Definições da Empresa e selecione o separador 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 Integrações.
- 4
Introduza um nome
Na janela modal apresentada, introduza um nome descritivo para a sua chave de API. Isto ajuda a identificar a chave mais tarde (por exemplo, "Integração Power BI" ou "Sincronização CRM").
- 5
Copie a sua chave
Depois de clicar em Criar, a sua chave de API será apresentada. Clique no botão de cópia para a copiar para a área de transferência. A chave apenas será apresentada uma vez!
Formato da chave de API
As chaves de API seguem este formato:
nm_{company}_{random_32_chars} - Todas as chaves começam por 'nm_'
- Prefixo específico da empresa para identificação
- 32 carateres aleatórios por motivos de segurança
Utilizar a sua chave de API
Inclua a chave de API no cabeçalho X-API-Key em cada pedido:
curl -X GET "https://api.nomid.tech/emm/api/v1/assets" \
-H "X-API-Key: nm_acme_a1b2c3d4e5f6..." Boas práticas de segurança
- Nunca exponha chaves de API em código do lado do cliente ou em repositórios públicos
- Faça a rotação regular de chaves e revogue chaves não utilizadas
- Armazene chaves em variáveis de ambiente, não no código
- Utilize as permissões mínimas necessárias para a sua integração
Erros de autenticação
A API devolve códigos de erro específicos para problemas de autenticação:
| Código de estado | Descrição |
|---|---|
| 401 | Chave de API em falta ou inválida |
| 403 | A chave de API não tem as permissões necessárias |
| 429 | Limite de pedidos excedido |