Usar a funcionalidade do UEM com uma REST API

É possível configurar aplicativos externos para usar a funcionalidade principal do produto do Workspace ONE UEM ao integrar REST APIs à infraestrutura do UEM, facilitando a conectividade. É possível também selecionar uma URL de token OAuth mais próxima ao centro de dados para autenticar chamadas de API.

Introdução às REST APIs

Usando a arquitetura simplificada do software REST, as REST APIs do Workspace ONE UEM atualmente suportam várias funcionalidades, incluindo grupo organizacional, administração de console, aplicativo móvel, dispositivo móvel, e-mail, usuário de inscrição, perfil, grupo inteligente e gerenciamento de grupo de usuários.

O uso de APIs baseadas em REST oferece vários benefícios para as empresas, incluindo a exclusão do custo e do tempo gastos no desenvolvimento de aplicativos internos. As REST APIs do Workspace ONE UEM estão totalmente aptas e prontas para integrar-se a servidores, programas e processos empresariais. As REST APIs do Workspace ONE UEM são mais eficientes e podem funcionar sem problemas e ser facilmente identificadas pelas empresas. Essas APIs são para desenvolvedores de aplicativos. Este guia fornece uma compreensão do design e da arquitetura da biblioteca de APIs e facilita o desenvolvimento e a integração personalizados com o Workspace ONE UEM.

Como acessar a documentação da API

Consulte a documentação detalhada da API ao acessar a página de Ajuda da API do Workspace ONE UEM.

1. Faça login no Workspace ONE UEM Console como administrador.
2. Na barra de endereços do seu navegador, substitua o "cn" no URL por "as" e depois acrescente /api/help após .com.

Por exemplo, a documentação da API do URL de um ambiente SaaS de...

https://cn4855.awmdm.com

...é...

https://as4855.awmdm.com/api/help

Datacenter e URLs de token para suporte ao OAuth 2.0

O Workspace ONE UEM suporta o protocolo padrão do setor OAuth 2.0 para autenticação e autorização seguras das chamadas REST API. O serviços de token do Workspace ONE é o emissor do token para autenticação OAuth e só é compatível com ambientes SaaS. Os URLs de token são específicos da região.

Criar um cliente OAuth para usar nos comandos da interface de programação de aplicativos (SaaS)

Você pode criar um cliente OAuth para usar comandos de interface de programação de aplicativos compatíveis somente com ambientes SaaS. Crie um cliente OAuth para seu ambiente SaaS seguindo as etapas a seguir.

1. Vá para Grupos e Configurações > Configurações.

2. Digite OAuth na caixa de texto de pesquisa chamada "Digite um nome ou categoria".

3. Selecione Gerenciamento do cliente OAuth que aparece nos resultados. A tela Gerenciamento do cliente OAuth é exibida.

4. Selecione o botão Adicionar.

5. Digite Nome, Descrição, Grupos organizacionais e Função.

   Observação: para obter mais informações sobre permissões de REST API específicas para a função selecionada, consulte a seção neste tópico chamada Criar Função que Permita o Uso de uma REST API.

6. Verifique se o Status está Ativado.

7. Selecione Salvar.

8. IMPORTANTE: copie o ID do Cliente e o Segredo do Cliente na área de transferência e salve-os antes de fechar essa tela. Selecione o ícone de Copiar () para enviar o Segredo do Cliente para a área de transferência.

   Não é possível retornar a essa tela para recuperar essas informações após você selecionar Fechar.

9. Usar o ID do cliente, Segredo do cliente e URL do token para gerar o token de acesso no seguinte formato:

   SOLICITAÇÃO HTTP

   Chamada da API: POST {URL do token específico da região da seção acima}

   PARÂMETROS DE ENTRADA

   Parâmetro	Exigido	Descrição
   tenant_url	Sim (URL)	Nome do host do seu tenant
   grant_type=client_credentials	Sim (Corpo)	Obrigatório para receber o token de acesso
   application/x-www-form-urlencoded	Sim (Cabeçalho)	Formato da codificação
   Autorização: Básica	Sim (Cabeçalho)	Você deve passar a string codificada em Base64 de client_id:Client_secret

10. Use o token de acesso retornado para autorizar solicitações de API futuras para os servidores de API do Workspace ONE UEM. Você deve formatar o token de acesso nos cabeçalhos da solicitação da seguinte maneira.

    Chamada da API: {UEM API}

    Chave	Valor
    Autorização	{Token de Acesso}

Criar função que permita o uso de uma REST API

Cada chamada de API tem um recurso correspondente (ou permissão) que deve ser incluído na função que será atribuída ao Cliente OAuth. Portanto, as permissões para inclusão na função atribuída se alinham aos tipos de chamadas de API sendo feitas.

Use as informações na tabela a seguir para ajudá-lo a selecionar quais permissões devem ser incluídos na função que atribuiu. Em seguida, acesse a seção Criar Função do Administrador em Acesso Baseado em Função para obter instruções sobre como criar essa função.