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

    Guia de Início Rápido

    Bem-vindo à API de métricas de pavimentação do PavRunner.
    Este guia resume o fluxo de integração para que sua equipe consiga autenticar, validar conectividade e começar a consumir os recursos de métricas com filtros, ordenação e paginação.

    1. Pré-requisitos#

    Para iniciar, você deve ter
    Base URL do ambiente
    https://api.pavrunner.com.br/v1
    Token de acesso fornecido pela RoadRunner
    Um cliente HTTP capaz de enviar JSON via POST

    2. Autenticação#

    Todas as chamadas devem incluir o header
    Authorization: Bearer <token>
    O token identifica seu ambiente e permissões. Ele deve ser tratado como credencial secreta.

    3. Primeira validação, ping#

    Use o recurso de ping para validar conectividade.
    POST /ping
    Resultado esperado
    HTTP 200 e payload indicando disponibilidade

    4. Como consultar dados#

    Os endpoints de listagem aceitam POST para permitir consultas com corpo JSON.
    Padrões
    Listagem
    POST /{recurso}
    Contagem
    POST /{recurso}/count
    Recursos típicos
    igg
    iri
    fwd

    5. Paginação#

    Campos
    page começa em 0
    pageSize controla o volume retornado
    Recomendação
    Defina pageSize conforme o volume esperado e os limites do seu consumidor.

    6. Ordenação#

    Use orderby para resultados determinísticos.
    orderby é uma lista de campos
    cada item pode ter /asc ou /desc
    Recomendação
    Se você informar orderby, envie o mesmo padrão nas consultas paginadas para estabilidade de paginação.

    7. Filtros#

    Use query para filtrar.
    query é um objeto de filtros
    cada filtro é campo ou campo/sufixo
    A lista completa de sufixos e regras está no documento
    Guia de Filtros Dinâmicos, Ordenação e Paginação

    8. Contrato de retorno#

    Listagem#

    A resposta inclui
    result lista de registros
    page página retornada
    pageSize tamanho configurado
    totalPages total de páginas
    totalResults total de registros para o filtro

    Count#

    A resposta inclui
    count total de registros para o filtro

    9. Checklist de integração#

    Recebeu e armazenou o token em local seguro
    Validou conectividade com POST /ping
    Implementou paginação com page e pageSize
    Definiu orderby estável quando houver paginação
    Implementou filtros via query conforme o guia
    Implementou uso de /count quando precisar totalizadores

    10. Documentos de referência#

    Guia de Consumo da API, Autenticação e Consultas via POST
    Guia de Filtros Dinâmicos, Ordenação e Paginação
    Política de Segurança e Responsabilidade sobre Tokens de Acesso
    Modificado em 2025-12-19 13:21:11
    Próxima página
    Política de Segurança e Responsabilidade sobre Tokens de Acesso
    Built with