Chamar a API do Microsoft 365 para transferir dados organizacionais para importação baseada em API (Passo 2 de 3) (pré-visualização)

Aplica-se a: Administrador Global do Microsoft 365 ou Administrador de Origem de Dados Organizacional ou Administrador do Sistema de Informações de Recursos Humanos

1. Preparar e exportar os seus dados numa frequência definida

Exporte dados organizacionais para todos os funcionários da empresa e adicione todos os campos que pretende importar num modelo de .csv ou numa saída de .csv automatizada numa origem externa, como o Workday Report as a Service (RaaS). Saiba como estruturar este ficheiro de dados.

Com a frequência que decidir (por exemplo, uma vez por mês ou uma vez por semana), peça à sua aplicação personalizada ou integração de origem externa para exportar dados organizacionais do seu sistema de origem.

2. Chame a API para importar os seus dados

Para importar os seus dados para o Microsoft 365, pode escolher uma de cinco opções:

1. Utilize a nossa API para criar uma aplicação personalizada que exporta e importa os seus dados com a frequência que escolher. Saiba como.

2. Execute a nossa solução C# na consola, que se baseia na nossa API. Saiba como.

3. Execute o nosso script do PowerShell, que também se baseia na nossa API. Saiba como.

4. Utilize um modelo de Azure Data Factory para enviar dados para a importação baseada em API. Saiba como.

5. Execute o nosso script no nó para obter tokens OAuth. Em seguida, utilize esses tokens para enviar dados diretamente a partir de uma origem externa, como o Workday, para a importação baseada em API. Saiba como.

Se estiver a trabalhar com a opção 1, 2, 3 ou 4, certifique-se de que tem estas informações:

• ID da aplicação (cliente). Localize este ID nas informações da aplicação registada no centro de administração do Microsoft Entra em ID da Aplicação (cliente).

• Segredo do cliente: esta é uma cadeia secreta que a aplicação utiliza para provar a sua identidade ao pedir um token. Também é conhecida como palavra-passe de aplicação. Este segredo só é apresentado pela primeira vez quando o segredo do cliente é criado. Para criar um novo segredo do cliente, siga estes passos.

• Nome do certificado. Este nome está configurado na sua aplicação registada. Depois de carregar o certificado, o nome do certificado é apresentado em Descrição no Portal do Azure. Pode utilizar o nome do certificado como alternativa ao segredo do cliente.

• Microsoft Entra ID do inquilino. Pode encontrar este ID na página de descrição geral da aplicação em ID de diretório (inquilino).

• Unidade de escala: a unidade de escala fornecida para o seu inquilino, como "novaprdwus2-01".

• O ficheiro .csv e o caminho para o ficheiro de .csv.

Em alternativa, se estiver a trabalhar com a opção 5, certifique-se de que tem estas informações:

• ID da aplicação (cliente). Localize este ID nas informações da aplicação registada no Centro de administração do Microsoft 365 em ID da Aplicação (cliente).

• Segredo do cliente: esta é uma cadeia secreta que a aplicação utiliza para provar a sua identidade ao pedir um token. Também é conhecida como palavra-passe de aplicação. Este segredo só é apresentado quando cria o segredo do cliente. Saiba como criar um novo segredo do cliente.

• Microsoft Entra ID do inquilino. Pode encontrar este ID na página de descrição geral da aplicação em ID de diretório (inquilino).

• ID do Conector: esta é a cadeia no final do URL que aparece quando seleciona o conector baseado em API no Centro de administração do Microsoft 365, como https://admin.cloud.microsoft/OrganizationalDataInM365/connection-details/[Connector ID here].

• Unidade de escala: a unidade de escala fornecida para o seu inquilino, como "novaprdwus2-01".

Enviar dados por push

Aplicação para chamar a API do Microsoft 365 para emitir conteúdo

[POST] https://api.orginsights.viva.office.com/v1.0/tenants/{tenantid}/modis/connectors/HR/ingestions/fileIngestion

Caso o conector não esteja definido:

403: Forbidden

Se o conector estiver definido, mas a ingestão anterior ainda não estiver concluída:

400: Bad request: Previous ingestion is not complete.

Opção 1: Utilizar a API do Microsoft 365 para criar uma aplicação de importação/exportação personalizada

Pode utilizar a API do Microsoft 365 para criar uma aplicação personalizada que exporta automaticamente dados do seu sistema de origem e, em seguida, importá-los para o Centro de administração do Microsoft 365.

A sua aplicação pode assumir qualquer formulário, como um script do PowerShell, mas tem de exportar os seus dados de origem como um ficheiro de .csv na frequência que escolher e importar esse ficheiro para as aplicações e serviços do Microsoft 365.

Opção 2: importar dados através da nossa solução C# depois de exportar dados através da sua aplicação personalizada

Depois de exportar os dados de origem como um ficheiro de .csv na frequência que escolher, pode executar a solução DescriptiveDataUploadApp C# na consola do . A solução DescriptiveDataUploadApp C# traz os seus dados armazenados localmente para o Microsoft 365. Saiba mais no GitHub.

Para executar a solução:

1. Clone esta aplicação para o seu computador ao executar o seguinte comando na linha de comandos:

   git clone https://github.com/microsoft/orgdata_apibasedimport.git.

2. Inclua os seguintes valores da consola.

   • AppID/ClientID
   • Caminho absoluto para o ficheiro de .csv. Formate o caminho da seguinte forma: C:\\Users\\JaneDoe\\OneDrive - Microsoft\\Desktop\\info.csv
   • ID do inquilino do Microsoft Entra
   • Nome do certificado

Opção 3: executar a solução DescriptiveDataUpload do PowerShell depois de exportar dados através da sua aplicação personalizada

Semelhante à opção 2, depois de exportar os dados de origem como um ficheiro de .csv na frequência que escolher, pode executar a solução DescriptiveDataUpload do PowerShell na consola do . A solução DescriptiveDataUpload do PowerShell traz os seus dados armazenados localmente para o Microsoft 365. Saiba mais no GitHub.

1. Clone o código fonte para o computador ao executar este comando na linha de comandos:

   git clone https://github.com/microsoft/orgdata_apibasedimport.git.

2. Abra uma nova janela do PowerShell como administrador.

3. Na janela do PowerShell, execute o seguinte comando:

   Install-Module -Name MSAL.PS

   Em alternativa, aceda a esta ligação da galeria do PowerShell para obter instruções sobre a instalação.

4. Definir parâmetros.

   • ClientID
   • pathTocsvFile
   • TenantId
   • novaScaleUnit
   • ingressDataType: HR
   • ClientSecret ou certificateName