Protocolo Integração TopPonto

11 Painel

11.1 Indicadores

Disponibiliza informações, como a quantidade de funcionários, empresas e equipamentos cadastrados, além de dados associados ao plano contratado.

11.1.1 Funcionários

Retorna as informações relacionadas ao número de funcionários admitidos, demitidos e o total atual.

Endpoint

https://integracao.topponto.com.br/painel/indicadores/funcionarios

Estrutura

Método	Cabeçalho	Body
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros (Não se enquadra)

Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)

Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "admitidos": 2538,
        "demitidos": 6005,
        "total": 8543
    },
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

11.1.2 Empresas

Retorna as informações relacionadas ao número de empresas ativas, inativas e o total atual.

Endpoint

https://integracao.topponto.com.br/painel/indicadores/empresas

Estrutura

Método	Cabeçalho	Body
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros (Não se enquadra)

Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)

Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "ativas": 3,
        "inativas": 1,
        "total": 4
    },
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

11.1.3 Coletores

Retorna as informações relacionadas ao número de coletores de acordo com suas categorias.

Endpoint

https://integracao.topponto.com.br/painel/indicadores/coletores

Estrutura

Método	Cabeçalho	Body
GET	Content-Type: application/json X-Auth-Token: “token” X-Api-Version: 1	JSON

Parâmetros (Não se enquadra)

Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)

Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "rep": 27,
        "inner": 16,
        "facial": 3,
        "outros": 1,
        "total": 47
    },
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

11.1.4 Plano

Retorna as informações relacionadas ao plano contratado.

Endpoint

https://integracao.topponto.com.br/painel/indicadores/plano

Estrutura

Método	Cabeçalho	Body
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros (Não se enquadra)

Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)

Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "limiteFuncionarios": 3000,
        "prazoExpira": "01/01/2025"
    },
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

11.1.5 Indicadores Agrupados

Retorna todos os indicadores.

Endpoint

https://integracao.topponto.com.br/painel/indicadores

Estrutura

Método	Cabeçalho	Body
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	JSON

Parâmetros (Não se enquadra)

Não há parâmetros a serem passados na requisição.

Requisição (Não se enquadra)

Não há dados a serem enviados na requisição.

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "funcionarios": {
            "admitidos": 2538,
            "demitidos": 6005,
            "total": 8543
        },
        "empresas": {
            "ativas": 3,
            "inativas": 1,
            "total": 4
        },
        "coletores": {
             "rep": 27,
             "inner": 16,
             "facial": 3,
             "outros": 1,
             "total": 47
        },
        "plano": {
            "limiteFuncionarios": 3000,
            "prazoExpira": "01/01/2025"
        }
    },
    "status": 200
}

Erros catalogados

Não há erros catalogados para este método.

11.2 Analíticos

Fornece métricas relacionadas a horas extras, banco de horas e entradas do dia. Informações apresentadas na tela “Painel de Controle” do TopPonto Web.

Todos os endpoints desta seção exigem o parâmetro timeZone. O valor do timeZone deve ser sempre fornecido em minutos negativos, conforme a diferença em relação ao UTC.

Exemplo de uso

O horário de Brasília é UTC-03:00, então na requisição deve ser fornecido o valor “-180”

11.2.1 Presença funcionários

Endpoint

https://integracao.topponto.com.br/painel/analitico/presenca-funcionarios/timeZone

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
timeZone	Number	-120, -180, -240, -300 (Número Negativo)	Sim	Fuso horário da empresa conforme sua localização no Brasil.

Requisição (URL)

https://integracao.topponto.com.br/analitico/presenca-funcionarios/-180

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "dataFormatada": "18/12/2024_BoaCarne",
        "dataProcessado": "17/12/2024 17:11:09",
        "data": 1734480000000,
        "presencasFuncionarios": [
            {
                "idFuncionarioPresenca": 1,
                "idDepartamento": 1,
                "idEmpresa": 1,
                "processado": 0,
                "nome": "NATALIA OLIVEIRA DA SILVA",
                "horario": "08:00",
                "observacao": "",
                "departamento": "FINANCEIRO",
                "empresa": "TOPDATA SISTEMAS",
                "pis": "12345678901",
                "legenda": "-",
                "ativo": "true",
                "dataDemissao": null,
                "data": 1734480000000
            },
            ...
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
timeZone	Timezone não pode ser nulo ou vazio.	400 – Bad Request
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request

11.2.2 Horas extras por adicionais

Fornece métricas relacionadas a horas extras por adicionais com base no timeZone informado no endpoint.

Endpoint

https://integracao.topponto.com.br/painel/analitico/horas-extras-adicionais/timeZone

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
timeZone	Number	-120, -180, -240, -300 (Número Negativo)	Sim	Fuso horário da empresa conforme sua localização no Brasil.

Requisição (URL)

https://integracao.topponto.com.br/analitico/horas-extras-adicionais/-180

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idDepartamento": 1,
            "qdtFuncionarios": 14,
            "departamentoDescricao": "Financeiro",
            "empresaDescricao": "Topdata sistemas de automação ltda.",
            "qtdHorasFormatada": "312h 32min",
            "adicionais": "150.0% - 147",
            "qtdHoras": 18752,
            "adicionaisReal": 150
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request

11.2.3 Horas extras por departamento

Fornece métricas relacionadas a horas extras por departamento com base no idEmpresa e timeZone informado no endpoint.

Endpoint

https://integracao.topponto.com.br/painel/analitico/horas-extras-departamento/idEmpresa/timeZone

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.
timeZone	Number	-120, -180, -240, -300 (Número Negativo)	Sim	Fuso horário da empresa conforme sua localização no Brasil.

Requisição (URL)

https://integracao.topponto.com.br/analitico/horas-extras-departamento/1/-180

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "qdtFuncionarios": 14,
            "departamentoDescricao": "Financeiro",
            "empresaDescricao": "Topdata sistemas de automação ltda.",
            "adicionaisDescricao": "Adicional Matriz",
            "qtdHorasFormatada": "312h 32min",
            "qtdHoras": 18752,
            "adicionaisReal": 150
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo ou 0.	400 – Bad Request
idEmpresa	Empresa não encontrada. Informe um id válido.	404 – Not Found

11.2.4 Banco de horas por departamento

Fornece métricas relacionadas a banco de horas por departamento com base no idEmpresa e timeZone informado no endpoint.

Endpoint

https://integracao.topponto.com.br/painel/analitico/banco-horas-departamento/idEmpresa/timeZone

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.
timeZone	Number	-120, -180, -240, -300 (Número Negativo)	Sim	Fuso horário da empresa conforme sua localização no Brasil.

Requisição (URL)

https://integracao.topponto.com.br/analitico/banco-horas-departamento/1/-180

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idDepartamento": 1,
            "idEmpresa": 1,
            "qdtFuncionarios": 14,
            "departamentoDescricao": "Financeiro",
            "empresaDescricao": "Topdata sistemas de automação ltda.",
            "adicionaisDescricao": "Adicional Matriz",
            "qtdHorasFormatada": "312h 32min",
            "qtdHoras": 18752,
            "qdtHorasReal": -7675
        },
        ...
    ],
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request
idEmpresa	O id da empresa não pode ser nulo ou 0.	400 – Bad Request
idEmpresa	Departamento não encontrado. Informe um id válido.	404 – Not Found

11.2.5 Analíticos Agrupados

Fornece todas as métricas agrupadas com base no idEmpresa e timeZone informado no endpoint.

Endpoint

https://integracao.topponto.com.br/painel/analitico/idEmpresa/timeZone

Estrutura

Método	Cabeçalho	Path Variable
GET	Content-Type: application/json X-Auth-Token: “token”X-Api-Version: 1	Integer

Parâmetros

Campo	Tipo	Restrição	Obrigatório	Descrição
idEmpresa	Number	1 a N (Número Positivo)	Sim	Identificador único da empresa.
timeZone	Number	-120, -180, -240, -300 (Número Negativo)	Sim	Fuso horário da empresa conforme sua localização no Brasil.

Requisição (URL)

https://integracao.topponto.com.br/analitico/1/-180

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "horasExtrasAdicionais": [
            {
                "idDepartamento": 1,
                "qdtFuncionarios": 14,
                "departamentoDescricao": "Financeiro",
                "empresaDescricao": "Topdata sistemas de automação ltda.",
                "qtdHorasFormatada": "312h 32min",
                "adicionais": "150.0% - 147",
                "qtdHoras": 18752,
                "adicionaisReal": 150
            },
            ...
        ],
        "presencasFuncionarios": [
            {
                "idFuncionarioPresenca": 1,
                "idDepartamento": 1,
                "idEmpresa": 1,
                "processado": 0,
                "nome": "NATALIA OLIVEIRA DA SILVA",
                "horario": "08:00",
                "observacao": "",
                "departamento": "FINANCEIRO",
                "empresa": "TOPDATA SISTEMAS",
                "pis": "12345678901",
                "legenda": "-",
                "ativo": "true",
                "dataDemissao": null,
                "data": 1734480000000
            },
            ...
        ],
        "horasExtrasDepartamento": [
            {
                "idDepartamento": 1,
                "idEmpresa": 1,
                "qdtFuncionarios": 14,
                "departamentoDescricao": "Financeiro",
                "empresaDescricao": "Topdata sistemas de automação ltda.",
                "adicionaisDescricao": "Adicional Matriz",
                "qtdHorasFormatada": "312h 32min",
                "qtdHoras": 18752,
                "adicionaisReal": 150
            },
            ...
        ],
        "bancoDeHorasDepartamento": [
            {
                "idDepartamento": 1,
                "idEmpresa": 1,
                "qdtFuncionarios": 14,
                "departamentoDescricao": "Financeiro",
                "empresaDescricao": "Topdata sistemas de automação ltda.",
                "adicionaisDescricao": "Adicional Matriz",
                "qtdHorasFormatada": "312h 32min",
                "qtdHoras": 18752,
                "qdtHorasReal": -7675
            },
            ...
        ]
    },
    "status": 200
}

Erros catalogados

Campo	Mensagem	Código Http
idEmpresa	Empresa não encontrada. Informe um id válido.	404 – Not Found
timeZone	Fuso horário inválido. Por favor, verifique o valor e tente novamente.	400 – Bad Request

Mais páginas

Mais Páginas

Introdução
Cadastros
Eventos
Erros Catalogados

Páginas: 1 2 3 4 5

« Anterior 1 2 3 4 5 Próxima »

Esse artigo foi útil?

Sim Não