ServiceLayer RH (API)

Documentação da API ServiceLayer 

Autenticação

Para acessar os endpoints da API, é necessário realizar um login para obter o access_token e o tenId. A requisição deve ser feita via POST para o seguinte endpoint:

Requisitos para Acesso

O acesso à API deve ser solicitado via chamado no portal do cliente. Certifique-se de que sua solicitação inclua todas as informações necessárias para o acesso.

Endpoint de Login

URL: https://master.starsoft.com.br/auth/api/AuthManagement/Loginsimplified

Método: POSTBody (JSON):{ "userName": "usuario", "password": "senha", "accessCode": "STARSOFT"}

Exemplo de uso

Após obter o access_token e o tenId, você pode utilizar os seguintes endpoints da API todas as chamadas devem incluir o token no cabeçalho de autorização.

Exemplo de chamada: http

GET https://rfp.starsoft.com.br/ServiceLayer/api/v1/Cargo/listar-cargos?tenId={{tenId}}Authorization: Bearer {{access_token}}

Alguns Endpoints

1. Listar Cargos

URL: https://rfp.starsoft.com.br/ServiceLayer/api/v1/Cargo/listar-cargos

Método: GET

Headers:Authorization: Bearer {{access_token}}

Parâmetros:tenId: O ID do tenant (obter do login).

2. Listar Hollerites Publicados

URL: https://rfp.starsoft.com.br/ServiceLayer/api/v1/ConsultasPaginadas/listar-hollerites-publicados

Método: GET

Headers:Authorization: Bearer {{access_token}}

Parâmetros:referencia: (string, formato: date-time)

colaborador: (string)

anomes: (string)

tipoCalculo: (string)

page: (integer)

pageSize: (integer)

tenId: O ID do tenant (obter do login)

3. Listar Colaboradores

URL: https://rfp.starsoft.com.br/ServiceLayer/api/v1/ConsultasPaginadas/listar-colaboradores

Método: GET

Headers:Authorization: Bearer {{access_token}}

Parâmetros:referencia: (string, formato: date-time)

searchText: (string)

page: (integer)

pageSize: (integer)

tenId: O ID do tenant (obter do login)

Observações

A URL https://rfp.starsoft.com.br/ServiceLayer é da nuvem padrão da StarSoft. Caso o cliente esteja hospedado em outra nuvem parceira ou ambiente próprio, a URL poderá ser diferente.

Documentação Completa

A documentação completa das APIs está disponível em: Swagger UI (starsoft.com.br)

• Related Articles

• Recomendações de Software e Hardware - Grupo StarSoft.

  Introdução Esta documentação tem como objetivo destacar a importância da topologia adequada para clientes que desejam hospedar os softwares da StarSoft em um ambiente próprio ou delegado a um parceiro da empresa, em vez de utilizar nuvens ...