APIs para importação dos dados

As APIs públicas para a importação e exportação dos dados utilizadas para o aplicativo Marcação de Ponto | HCM estão disponíveis no Portal Dev.Senior, junto com o [tutorial](https://api.xplatform.com.br/api-portal/pt-br/tutoriais/api-hcm) sobre como utilizá-las para realizar a importação dos dados.

Principais APIs utilizadas:

• BlobServiceRequestUploadFile
• BlobServiceCommitUploadedFile
• EmployeesImportByFileId
• EmployeesImportByCsv
• employeesSync
• ClockingEventExport
• ClockingEventExportByPeriod

Importação dos dados

Inicialmente, para a sua aplicação, é necessário criar um arquivo do tipo .TMP para armazenar as informações necessárias dos colaboradores que serão importados para o aplicativo. O arquivo será enviado para a Plataforma Senior X, que irá processar os colaboradores sem impactar em outras funcionalidades. Para isso:

1. Solicite o upload do arquivo através do endpoint BlobServiceRequestUploadFile, que retornará o endereço para ser feito o upload do arquivo e o identificador do arquivo. Este identificador será necessário nos próximos passos da importação;
2. Após o upload confirme o arquivo dentro da plataforma. Para isso utilize o endpoint BlobServiceCommitUploadedFile, informando o identificador do arquivo;
3. Utilize o endpoint EmployeesImportByFileId para enviar o identificador do arquivo que a solução deve processar, a solução irá realizar, de forma síncrona, a persistência destas informações.
   
   Caso utilize o endpoint EmployeesImportByCsv, será necessário realizar os passos de BlobServiceRequestUploadFile e BlobServiceCommitUploadedFile. Este processamento ocorre de forma assíncrona e ao término uma mensagem é enviada para o usuário que realizou a solicitação de importação, ficando visível na Plataforma Senior X. Com o endpoint EmployeesImportByCsv, o arquivo gerado deve ser um .CSV seguindo os padrões sugeridos. De ambas as formas a solução já terá inserido dados referentes à: colaboradores, gestores, unidades de negócio e usuários da plataforma.

    {  
        "updates": [ // Inclusão ou atualização de colaboradores
            {
                "externalId": "string", //Identificador externo do sistema origem
                "name": "string",
                "cpfNumber": "string", // CPF sem caracteres especiais.
                "mail": "string",
                "company": {
                    "cnpj": "string", // CNPJ sem caracteres especiais.
                    "name": "string",
                    "timezone": "string",
                    "headquarters": "boolean",
                    "conventionOrAggremantNumber": "string",
                    "cnoNumber": "string",
                    "address": {
                        "cep": "string",
                        "address": "string",
                        "number": "string",
                        "complement": "string",
                        "neighborhood": "string",
                        "city": "string",
                        "state": "string",
                        "country": "string",
                    },
                    "caepf": "string",
                    "legalRepresentativeIdentifier": "integer",
                    "externalControlTimezone": "boolean",
                    "externalId": "string"
                },
                "managers": [
                    {
                        "mail": "string",
                        "platformUsers": [
                            {
                                "username": "string" //Usuário da plataforma
                            }
                        ]
                    }
                ],
                "platformUsers": [
                    {
                        "username": "string" //Usuário da plataforma
                    }
                ],
                "registrationNumber": "integer",
                "employeeType": "COMPANY_EMPLOYEE", //COMPANY_EMPLOYEE, THIRD_PARTY_EMPLOYEE, PARTNER_EMPLOYEE
                "shift": "string",
                "workSchedule": "string",
                "timeTable": "string",
                "timezone": "string",
                "externalControlTimezone": "boolean",
                "nfcCode" : "string", //Código NFC do colaborador, campo opcional
                "employeeCode" : "string", //Campo para armazenar informações de Código de Barras/QRCode do colaborador, campo opcional
            }
        ], 
        "deletes": [] // Desativação de colaboradores, recebe mesmo objeto de updates
    }

Exportação dos dados

Os dados a serem exportados pela aplicação são os das marcações de ponto realizados pelos colaboradores. E para exportar os dados será necessário consumir a API ClockingEventExport para receber todas as marcações que não tenham sido consumidas previamente.

Após a exportação, todas as marcações que foram exportadas desta forma ficam sinalizadas como sincronizadas e não serão enviadas em uma próxima chamada da API. Caso seja necessário o consumo de marcações já sinalizadas como sincronizadas deve-se consumir a API ClockingEventExportByPeriod.

Além dos dados de marcação, existe a possibilidade de exportar informações sobre as ativações de dispositivos e colaboradores utilizando, respectivamente, as APIs ActivationsExport e EmployeesExport. Para a exportação dos registros de pernoite, utilize a API overnightExport. Consulte o artigo Consumindo uma API, do Portal Dev. Senior, para mais informações.