Chamar a API do Microsoft 365 para transferir dados organizacionais para importação baseada em API (Etapa 2 de 3) (versão prévia)

Importante

Esse recurso é somente para clientes de visualização pública. Os recursos da versão prévia podem não estar completos e podem sofrer alterações antes de serem disponibilizados na versão mais ampla.

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

1. Preparar e exportar seus dados com uma frequência definida

Exporte dados organizacionais de todos os funcionários da empresa e adicione todos os campos que deseja importar em um modelo de .csv ou uma saída de .csv automatizada em uma fonte externa, como o Relatório do dia de trabalho como serviço (RaaS). Saiba como estruturar esse arquivo de dados.

Na frequência que você decidir (como uma vez por mês ou uma vez por semana), faça com que seu aplicativo personalizado ou integração de fonte externa exporte dados organizacionais do seu sistema de origem.

2. Chamar a API para importar seus dados

Para importar seus dados para o Microsoft 365, você pode escolher uma das cinco opções:

  1. Use nossa API para criar um aplicativo personalizado que exporta e importa seus dados na frequência que você escolher. Saiba como.

  2. Execute nossa solução C# em seu console, que é baseada em nossa API. Saiba como.

  3. Execute nosso script do PowerShell, que também é baseado em nossa API. Saiba como.

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

  5. Execute nosso script de nó para recuperar tokens OAuth. Em seguida, use esses tokens para enviar dados diretamente de uma fonte externa, como o Workday, para a importação baseada em API. Saiba como.

Observação

Nossas soluções C# e PowerShell importam apenas dados para o Serviço de Dados Organizacionais do Microsoft 365. Eles não exportam dados do seu sistema de origem.

Se você estiver trabalhando com a opção 1, 2, 3 ou 4, verifique se tem estas informações:

  • ID do aplicativo (cliente). Encontre essa ID nas informações do aplicativo registrado no centro de administração do Microsoft Entra, em ID do aplicativo (cliente).

  • Segredo do cliente: essa é uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade ao solicitar um token. Ela também é conhecida como senha do aplicativo. Esse segredo só é mostrado pela primeira vez quando o segredo do cliente é criado. Para criar um novo segredo do cliente, siga estas etapas.

  • Nome do certificado. Esse nome é configurado no seu aplicativo registrado. Depois de carregar o certificado, o nome do certificado aparece em Descrição no Portal do Azure. Você pode usar o nome do certificado como uma alternativa ao segredo do cliente.

  • ID do locatário do Microsoft Entra. Você pode encontrar essa ID na página de visão geral do aplicativo em ID do diretório (locatário).

  • Unidade de escala: a unidade de escala fornecida a você para seu locatário, como "novaprdwus2-01".

  • O arquivo .csv e o caminho para o arquivo .csv.

Ou, se você estiver trabalhando com a opção 5, verifique se tem estas informações:

  • ID do aplicativo (cliente). Encontre essa ID nas informações do aplicativo registrado no Centro de administração do Microsoft 365 em ID do aplicativo (cliente).

  • Segredo do cliente: essa é uma cadeia de caracteres secreta que o aplicativo usa para provar sua identidade ao solicitar um token. Ela também é conhecida como senha do aplicativo. Esse segredo só é mostrado quando você cria o segredo do cliente. Saiba como criar um novo segredo de cliente.

  • ID do locatário do Microsoft Entra. Você pode encontrar essa ID na página de visão geral do aplicativo em ID do diretório (locatário).

  • ID do conector: essa é a cadeia de caracteres no final da URL que aparece quando você seleciona seu 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 a você para seu locatário, como "novaprdwus2-01".

Enviar dados por push

Aplicativo para chamar a API do Microsoft 365 para enviar conteúdo por push

[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: usar a API do Microsoft 365 para criar um aplicativo personalizado de importação/exportação

Você pode usar a API do Microsoft 365 para criar um aplicativo personalizado que exporta automaticamente dados do seu sistema de origem e, em seguida, os importa para o Centro de administração do Microsoft 365.

Seu aplicativo pode assumir qualquer forma, como um script do PowerShell, mas precisa exportar seus dados de origem como um arquivo .csv na frequência que você escolher e importar esse arquivo para aplicativos e serviços do Microsoft 365.

Opção 2: Importar os dados por meio de nossa solução C# após exportar os dados por meio de seu aplicativo personalizado

Depois de exportar os dados de origem como um arquivo .csv na frequência escolhida, você poderá executar a solução C# DescriptiveDataUploadApp no console. A solução DescriptiveDataUploadApp C# traz seus dados armazenados localmente para o Microsoft 365. Saiba mais no GitHub.

Para executar a solução:

  1. Clone este aplicativo em seu computador executando o seguinte comando na linha de comando:

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

  2. Inclua os seguintes valores de console.

    • AppID/ClientID
    • Caminho absoluto para o arquivo .csv. Formate o caminho desta forma: C:\\Users\\JaneDoe\\OneDrive - Microsoft\\Desktop\\info.csv
    • ID do locatário do Microsoft Entra
    • Nome do certificado

Opção 3: execute a solução DescriptiveDataUpload do PowerShell depois de exportar os dados por meio do seu aplicativo personalizado

Semelhante à opção 2, depois de exportar os dados de origem como um arquivo .csv na frequência escolhida, você poderá executar a solução DescriptiveDataUpload do PowerShell no console. A solução DescriptiveDataUpload do PowerShell traz seus dados armazenados localmente para o Microsoft 365. Saiba mais no GitHub.

  1. Clone o código-fonte em seu computador executando este comando na linha de comando:

    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

    Ou acesse o link da galeria do PowerShell para obter instruções sobre a instalação.

  4. Defina parâmetros.

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