PAVRUNNER
    PAVRUNNER
    • Guia de Início Rápido
    • Política de Segurança e Responsabilidade sobre Tokens de Acesso
    • Uso da API, Autenticação e Consultas via POST
    • Filtros Dinâmicos (query), Ordenação (orderby) e Paginação
    • API
      • v1
        • Ping
          GET
        • IGG
          POST
        • IRI
          POST
        • ICP
          POST
        • FWD
          POST
        • TR
          POST
        • SAT
          POST
        • CAMPAIGN
          POST
        • ROAD
          POST
        • ROAD SEGMENT
          POST
        • UNIFILAR WORKS
          POST

    Uso da API, Autenticação e Consultas via POST

    Este documento padroniza o consumo dos endpoints de métricas de pavimentação expostos em /v1.

    Base URL#

    https://api.pavrunner.com.br/v1

    Por que os endpoints usam POST#

    Os endpoints de listagem e consulta aceitam POST para permitir o envio de um corpo JSON com filtros dinâmicos, ordenação e paginação.
    Regra
    Para consultar e filtrar, utilize POST no recurso.
    Para obter contagem, utilize POST no sufixo /count.

    Autenticação#

    A API exige header Authorization no formato Bearer.
    Authorization: Bearer <token>
    O token será fornecido e repassado ao cliente pela RoadRunner.
    Observações
    O token é obrigatório para qualquer chamada.
    Tokens são credenciais. Não devem ser expostos em logs, prints ou repositórios.

    Headers recomendados#

    Content-Type: application/json
    Accept: application/json

    Padrão de endpoints#

    Os recursos de métricas são acessados por nome.
    POST /{recurso}
    POST /{recurso}/count
    Exemplos de recursos
    /igg
    /fwd
    /iri
    A lista de recursos disponíveis depende do ambiente do cliente.

    Corpo da requisição#

    Todos os campos são opcionais.
    page integer, default 0
    pageSize integer, default 100
    orderby array de strings
    query object
    O detalhamento de query e orderby está no documento: Guia de Filtros Dinâmicos, Ordenação e Paginação.

    Contrato de resposta#

    Listagem#

    O retorno contém
    result array de registros
    page integer
    pageSize integer
    totalPages integer
    totalResults integer
    Campos de auditoria podem ser omitidos do retorno conforme política do sistema.

    Contagem#

    O retorno contém
    count integer

    Erros#

    401 UNAUTHORIZED
    ausente ou inválido Authorization: Bearer <token>
    404 NOT FOUND
    recurso inexistente ou não habilitado no ambiente
    500 INTERNAL SERVER ERROR
    falha interna de execução
    Quando existir payload de erro, ele deve ser tratado como instável entre versões, a não ser que exista um padrão formal de erros.

    Boas práticas de consumo#

    Se você informar orderby, envie o mesmo padrão nas consultas paginadas para estabilidade de paginação.
    Use pageSize conservador quando houver colunas com geometrias ou textos extensos.
    Para telas com totalizadores, use /count com o mesmo query.
    Separe consultas de leitura de rotas críticas, evite múltiplas consultas sem necessidade.

    Segurança e compliance#

    Evite replicar o token em sistemas terceiros.
    Se for necessário armazenar token, use vault ou secret manager.
    Em caso de suspeita de vazamento, solicite rotação do token.

    Versionamento#

    A versão da API está no path.
    /v1
    Mudanças incompatíveis devem gerar uma nova versão de path.
    Modificado em 2025-12-19 13:19:02
    Página anterior
    Política de Segurança e Responsabilidade sobre Tokens de Acesso
    Próxima página
    Filtros Dinâmicos (query), Ordenação (orderby) e Paginação
    Built with