Compartilhar via


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

Importante

Esta funcionalidade destina-se apenas a clientes de pré-visualização pública. As funcionalidades em pré-visualização podem não estar concluídas e podem sofrer alterações antes de ficarem disponíveis na versão mais abrangente.

Aplica-se a: Administrador Global do Microsoft 365 ou Administrador de Origem de Dados Organizacional ou Administrador do sistema de Origem HRIS

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

Importe dados organizacionais para todos os funcionários da empresa e adicione todos os campos que pretende importar num modelo de .csv. 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 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 entre três opções:

  • 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.

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

  • Execute o nosso script do PowerShell, que também se baseia na nossa API. [Ligações para a Opção 3 abaixo.]

Observação

As nossas soluções C# e PowerShell só importam dados para Dados Organizacionais no Microsoft 365. Não exportam dados do seu sistema de origem.

Antes de trabalhar com qualquer uma das opções abaixo, 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.

Enviar dados por push

Aplicação de inquérito 1P/3P 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

[Corpo] conteúdo do ficheiro como multipart/form-data

Tipo: Arquivo zip

Conteúdo a arquivar:

Metadata.json

Data.csv

[Corpo do Pedido]

Body: 

{ 

   "$content-type": "multipart/form-data", 

   "$multipart":  

    [ 

        { 

            "headers":  

                { 

                    "Content-Disposition": "form-data; name=\"file\"; filename=info" 

                   }, 

            "body": @{body('Get_blob_content_(V2)')} 

         } 

    ] 

} 

[Corpo da Resposta]

200:  
{ 

  "FriendlyName": "Data ingress", 

  "Id": "<ingestion Id>", 

  "ConnectorId": "<connector Id>", 

  "Submitter": "System", 

  "StartDate": "2023-05-08T19:07:07.4994043Z", 

  "Status": "NotStarted", 

  "ErrorDetail": null, 

  "EndDate": null, 

  "Type": "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