1. Home
  2. Integração com o TopPonto
  3. Protocolo Integração TopPonto

Protocolo Integração TopPonto

12 Marcações


12.1 Consultar uma marcação

Endpoint

https://integracao.topponto.com.br/marcacoes/idMarcacao

Estrutura

MétodoCabeçalhoPath Variable
GETContent-Type: application/json X-Auth-Token: “token”X-Api-Version: 1Integer

Requisição (URL)

https://integracao.topponto.com.br/marcacoes/11


Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": {
        "idMarcacao": 11,
        "dataHora": "2025-09-12 14:08",
        "status": "Original",
        "motivo": null,
        "coletor": {
            "numeroSerie": null,
            "tipoEquipamento": "REP-P:Mobile",
            "local": "Rodovia Curitiba - Ponta Grossa Br-277, 2070 - Santo Inácio, Curitiba - Paraná, 82010-470, Brasil",
            "latitude": "-25.4300052",
            "longitude": "-49.333424699999995"
        },
        "funcionario": {
            "idFuncionario": 1,
            "matricula": null,
            "cpf": "11144477735",
            "nome": "Funcionario 1",
            "empresa": "Topdata Sistemas de Automação Ltda",
            "idEmpresa": 1
        },
        "nsr": "4"
    },
    "status": 200
}

Erros catalogados

MensagemCódigo Http
O id não pode ser nulo ou zero.400 – Bad Request
O id informado deve ser um número inteiro.400 – Bad Request
O id informado não foi encontrado.404 – Not Found

12.2 Consultar marcações de um período

Consultar marcações de um período.

Endpoint

https://integracao.topponto.com.br/marcacoes

Estrutura

MétodoCabeçalhoPath Variable
POSTContent-Type: application/json X-Auth-Token: “token”X-Api-Version: 1Integer

Parâmetros

CampoTipoRestriçãoObrigatórioDescrição
idFuncionarioNumber1 a N (Número Positivo) ou NULLNãoIdentificador único do funcionario.
periodoInicioStringExatos 10 caracteresSimData de inicio do dados (formato DD/MM/AAAA).
periodoFimStringExatos 10 caracteresSimData final do dados (formato DD/MM/AAAA).
originaisBooleantrue ou falseSimtrue para buscar marcações originais.
incluidasBooleantrue ou falseSimtrue para buscar marcações incluídas.
desconsideradasBooleantrue ou falseSimtrue para buscar marcações desconsideradas.
preAssinaladasBooleantrue ou falseSimtrue para buscar marcações pré-assinaladas.

Requisição (JSON)

{
    "idFuncionario": null,
    "dataInicio": "08/09/2025",
    "dataFim": "09/09/2025",
    "originais": true,
    "incluidas":true,
    "desconsideradas": true,
    "preAssinaladas": true
}

Resposta

{
    "message": "Consulta realizada com sucesso.",
    "body": [
        {
            "idMarcacao": 33,
            "dataHora": "2025-09-08 08:00",
            "status": "Incluída",
            "motivo": "Acabou a bobina da impressora",
            "coletor": null,
            "funcionario": {
                "idFuncionario": 1,
                "matricula": null,
                "cpf": "11144477735",
                "nome": "Funcionario 1",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        },
        {
            "idMarcacao": 34,
            "dataHora": "2025-09-08 18:00",
            "status": "Incluída",
            "motivo": "Acabou a bobina da impressora",
            "coletor": null,
            "funcionario": {
                "idFuncionario": 1,
                "matricula": null,
                "cpf": "11144477735",
                "nome": "Funcionario 1",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        },
        {
            "idMarcacao": 35,
            "dataHora": "2025-09-08 12:00",
            "status": "Pré-assinalada",
            "motivo": null,
            "coletor": null,
            "funcionario": {
                "idFuncionario": 1,
                "matricula": null,
                "cpf": "11144477735",
                "nome": "Funcionario 1",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        },
        {
            "idMarcacao": 36,
            "dataHora": "2025-09-08 13:00",
            "status": "Pré-assinalada",
            "motivo": null,
            "coletor": null,
            "funcionario": {
                "idFuncionario": 1,
                "matricula": null,
                "cpf": "11144477735",
                "nome": "Funcionario 1",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        },
        {
            "idMarcacao": 37,
            "dataHora": "2025-09-09 08:00",
            "status": "Incluída",
            "motivo": "Acabou a bobina da impressora",
            "coletor": null,
            "funcionario": {
                "idFuncionario": 2,
                "matricula": null,
                "cpf": "00000000000",
                "nome": "Funcionario 2",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        },
        {
            "idMarcacao": 38,
            "dataHora": "2025-09-09 12:00",
            "status": "Incluída",
            "motivo": "Acabou a bobina da impressora",
            "coletor": null,
            "funcionario": {
                "idFuncionario": 2,
                "matricula": null,
                "cpf": "00000000000",
                "nome": "Funcionario 2",
                "empresa": "Topdata Sistemas de Automação Ltda",
                "idEmpresa": 1
            },
            "nsr": null
        }
    ],
    "status": 200
}

CampoMensagemCódigo Http
idFuncionarioO id do funcionário deve ser maior que 0.400 – Bad Request
dataInicioA data de início deve estar no formato dd/MM/yyyy e ser uma data válida.400 – Bad Request
O data de início ultrapassou o limite definido.400 – Bad Request
A data de início não pode ser vazia.400 – Bad Request
dataFimA data de fim deve estar no formato dd/MM/yyyy e ser uma data válida.400 – Bad Request
A data de fim não pode ser vazia.400 – Bad Request
A data de fim ultrapassou o limite definido.400 – Bad Request
A data de fim não pode ser menor à data inicial.400 – Bad Request
dataInicio
dataFim
O intervalo entre as datas excede o limite permitido de meses para consulta de marcações.400 – Bad Request

Mais páginas

Mais Páginas

Introdução
Cadastros
Eventos
Cálculos
Painel
Erros Catalogados


Páginas: 1 2 3 4 5 6 7
Esse artigo foi útil?