{
  "openapi": "3.0.3",
  "info": {
    "title": "Pedágio Eletrônico — API pública do portal",
    "version": "1.0.0",
    "description": "Contrato das consultas públicas auxiliares e serviços do portal Pedágio Eletrônico. Suporta versionamento v1, paginação por cursor, idempotência e execução assíncrona. A área do cliente usa sessão autenticada e não faz parte deste contrato.",
    "contact": {
      "name": "Central de Atendimento Pedágio Eletrônico",
      "url": "https://movviape.zendesk.com/hc/pt-br"
    }
  },
  "servers": [
    {
      "url": "https://www.pedagioeletronico.com.br",
      "description": "Servidor de Produção"
    },
    {
      "url": "https://hml.api.pedagioeletronico.com.br",
      "description": "Ambiente de Sandbox e Homologação para testes de agentes"
    },
    {
      "url": "https://www.pedagioeletronico.com.br/api/v1/sandbox",
      "description": "Sandbox Mock para validação segura de chamadas"
    }
  ],
  "security": [
    {
      "OAuth2": [
        "read:public"
      ]
    }
  ],
  "paths": {
    "/api/cnpj": {
      "get": {
        "operationId": "consultarCadastroCnpj",
        "summary": "Consulta dados cadastrais públicos de uma pessoa jurídica pelo CNPJ usando BrasilAPI.",
        "description": "Consulta dados cadastrais públicos de uma pessoa jurídica pelo CNPJ usando BrasilAPI. Caracteres não numéricos são removidos antes da validação. Esta consulta não acessa contas, veículos, saldo ou pagamentos.",
        "tags": [
          "Consultas auxiliares"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "cnpj",
            "required": true,
            "description": "CNPJ com 14 dígitos; pontuação é aceita.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Consulta concluída.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "razaoSocial": {
                      "type": "string"
                    },
                    "nomeFantasia": {
                      "type": "string"
                    },
                    "situacao": {
                      "type": "string"
                    },
                    "atividadePrincipal": {
                      "type": "string"
                    },
                    "cep": {
                      "type": "string"
                    },
                    "logradouro": {
                      "type": "string"
                    },
                    "numero": {
                      "type": "string"
                    },
                    "complemento": {
                      "type": "string"
                    },
                    "bairro": {
                      "type": "string"
                    },
                    "municipio": {
                      "type": "string"
                    },
                    "uf": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Parâmetro ausente ou quantidade de dígitos inválida.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Cadastro ou endereço não encontrado.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "500": {
            "description": "Falha ao consultar o serviço externo.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "default": {
            "description": "Erro retornado pelo serviço de consulta.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/viacep": {
      "get": {
        "operationId": "consultarEnderecoCep",
        "summary": "Consulta os campos de endereço correspondentes ao CEP usando ViaCEP.",
        "description": "Consulta os campos de endereço correspondentes ao CEP usando ViaCEP. Caracteres não numéricos são removidos antes da validação. Esta consulta não acessa contas, veículos, saldo ou pagamentos.",
        "tags": [
          "Consultas auxiliares"
        ],
        "parameters": [
          {
            "in": "query",
            "name": "cep",
            "required": true,
            "description": "CEP com 8 dígitos; pontuação é aceita.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Consulta concluída.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "cep": {
                      "type": "string"
                    },
                    "logradouro": {
                      "type": "string"
                    },
                    "complemento": {
                      "type": "string"
                    },
                    "bairro": {
                      "type": "string"
                    },
                    "localidade": {
                      "type": "string"
                    },
                    "uf": {
                      "type": "string"
                    },
                    "ibge": {
                      "type": "string"
                    },
                    "gia": {
                      "type": "string"
                    },
                    "ddd": {
                      "type": "string"
                    },
                    "siafi": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Parâmetro ausente ou quantidade de dígitos inválida.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Cadastro ou endereço não encontrado.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "500": {
            "description": "Falha ao consultar o serviço externo.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "default": {
            "description": "Erro retornado pelo serviço de consulta.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/cnpj": {
      "get": {
        "operationId": "consultarCadastroCnpjV1",
        "summary": "Consulta dados cadastrais públicos de uma pessoa jurídica pelo CNPJ (v1).",
        "description": "Consulta dados cadastrais públicos de uma pessoa jurídica pelo CNPJ usando BrasilAPI na versão 1 da API.",
        "tags": [
          "Consultas auxiliares v1"
        ],
        "security": [
          {
            "OAuth2": [
              "read:public"
            ]
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "cnpj",
            "required": true,
            "description": "CNPJ com 14 dígitos; pontuação é aceita.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Consulta concluída.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "razaoSocial": {
                      "type": "string"
                    },
                    "nomeFantasia": {
                      "type": "string"
                    },
                    "situacao": {
                      "type": "string"
                    },
                    "atividadePrincipal": {
                      "type": "string"
                    },
                    "cep": {
                      "type": "string"
                    },
                    "logradouro": {
                      "type": "string"
                    },
                    "numero": {
                      "type": "string"
                    },
                    "complemento": {
                      "type": "string"
                    },
                    "bairro": {
                      "type": "string"
                    },
                    "municipio": {
                      "type": "string"
                    },
                    "uf": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Parâmetro ausente ou quantidade de dígitos inválida.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Cadastro ou endereço não encontrado.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/viacep": {
      "get": {
        "operationId": "consultarEnderecoCepV1",
        "summary": "Consulta os campos de endereço correspondentes ao CEP usando ViaCEP (v1).",
        "description": "Consulta os campos de endereço correspondentes ao CEP usando ViaCEP na versão 1 da API.",
        "tags": [
          "Consultas auxiliares v1"
        ],
        "security": [
          {
            "OAuth2": [
              "read:public"
            ]
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "cep",
            "required": true,
            "description": "CEP com 8 dígitos; pontuação é aceita.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Consulta concluída.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "cep": {
                      "type": "string"
                    },
                    "logradouro": {
                      "type": "string"
                    },
                    "complemento": {
                      "type": "string"
                    },
                    "bairro": {
                      "type": "string"
                    },
                    "localidade": {
                      "type": "string"
                    },
                    "uf": {
                      "type": "string"
                    },
                    "ibge": {
                      "type": "string"
                    },
                    "gia": {
                      "type": "string"
                    },
                    "ddd": {
                      "type": "string"
                    },
                    "siafi": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Parâmetro ausente ou quantidade de dígitos inválida.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          },
          "404": {
            "description": "Cadastro ou endereço não encontrado.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/concessionarias": {
      "get": {
        "operationId": "listarConcessionariasV1",
        "summary": "Lista concessionárias integradas com paginação por cursor.",
        "description": "Retorna a lista paginada de concessionárias integradas à plataforma de pedágio eletrônico Free Flow com suporte a cursor e limites.",
        "tags": [
          "Concessionárias"
        ],
        "security": [
          {
            "OAuth2": [
              "read:public"
            ]
          }
        ],
        "parameters": [
          {
            "in": "query",
            "name": "cursor",
            "required": false,
            "description": "Cursor opaco para a próxima página de resultados.",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "description": "Quantidade máxima de registros a retornar por página (padrão: 20, máx: 100).",
            "schema": {
              "type": "integer",
              "default": 20
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Lista paginada de concessionárias integradas.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "nome": {
                            "type": "string"
                          },
                          "sigla": {
                            "type": "string"
                          },
                          "rodovias": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "status": {
                            "type": "string"
                          },
                          "porticos": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    "nextCursor": {
                      "type": "string",
                      "nullable": true
                    },
                    "hasMore": {
                      "type": "boolean"
                    },
                    "total": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/consultas/lote": {
      "post": {
        "operationId": "iniciarConsultaLoteV1",
        "summary": "Inicia uma consulta em lote assíncrona com chave de idempotência.",
        "description": "Envia um lote de placas para verificação assíncrona. Aceita o cabeçalho Idempotency-Key para evitar duplicidade e retorna HTTP 202 com o cabeçalho Location apontando para o status do processamento.",
        "tags": [
          "Operações em Lote e Assíncronas"
        ],
        "security": [
          {
            "OAuth2": [
              "write:consultas"
            ]
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": true,
            "description": "Identificador único da requisição (UUID v4) para garantir execução idempotente.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "placas"
                ],
                "properties": {
                  "placas": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "Lista de placas para verificação em lote de passagens."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "202": {
            "description": "Consulta em lote aceita para processamento assíncrono.",
            "headers": {
              "Location": {
                "description": "URL para acompanhar o status e obter os resultados do processamento.",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "pollUrl": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Lote inválido ou chave de idempotência ausente.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/jobs/{id}": {
      "get": {
        "operationId": "consultarStatusJobV1",
        "summary": "Consulta o status de um processamento assíncrono.",
        "description": "Retorna o status atual e resultados de um job assíncrono previamente iniciado na plataforma.",
        "tags": [
          "Operações em Lote e Assíncronas"
        ],
        "security": [
          {
            "OAuth2": [
              "read:public"
            ]
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "description": "Identificador único do job assíncrono.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status do job retornado com sucesso.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string",
                      "enum": [
                        "pending",
                        "processing",
                        "completed",
                        "failed"
                      ]
                    },
                    "createdAt": {
                      "type": "string"
                    },
                    "completedAt": {
                      "type": "string",
                      "nullable": true
                    },
                    "result": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Job não encontrado.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiError"
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/batch": {
      "post": {
        "operationId": "executarLoteRequisicoesV1",
        "summary": "Executa múltiplas operações em uma única requisição (Batch).",
        "description": "Endpoint para processamento em lote de múltiplas consultas auxiliares em paralelo.",
        "tags": [
          "Operações em Lote e Assíncronas"
        ],
        "security": [
          {
            "OAuth2": [
              "write:consultas"
            ]
          }
        ],
        "parameters": [
          {
            "in": "header",
            "name": "Idempotency-Key",
            "required": false,
            "description": "Chave de idempotência para garantir que o lote não seja executado múltiplas vezes.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "operations"
                ],
                "properties": {
                  "operations": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "method",
                        "path"
                      ],
                      "properties": {
                        "method": {
                          "type": "string",
                          "enum": [
                            "GET",
                            "POST"
                          ]
                        },
                        "path": {
                          "type": "string"
                        },
                        "body": {
                          "type": "object"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Resultados de todas as operações do lote.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "status": {
                            "type": "integer"
                          },
                          "data": {
                            "type": "object"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/sandbox": {
      "get": {
        "operationId": "consultarSandboxV1",
        "summary": "Verifica disponibilidade do ambiente de sandbox / testes.",
        "description": "Retorna informações e parâmetros de teste para validação de agentes sem impacto em dados de produção.",
        "tags": [
          "Sandbox e Testes"
        ],
        "security": [
          {
            "OAuth2": [
              "read:public"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "Sandbox ativo.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "environment": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiError": {
        "type": "object",
        "required": [
          "error"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Mensagem de erro em português."
          },
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "resolution": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "description": "Autenticação OAuth 2.0 para agentes e serviços com permissões granulares.",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://www.pedagioeletronico.com.br/oauth/authorize",
            "tokenUrl": "https://www.pedagioeletronico.com.br/oauth/token",
            "scopes": {
              "read:public": "Acesso de leitura a informações públicas de pedágio e concessionárias",
              "write:consultas": "Execução de consultas em lote e validações de veículos"
            }
          },
          "clientCredentials": {
            "tokenUrl": "https://www.pedagioeletronico.com.br/oauth/token",
            "scopes": {
              "read:public": "Acesso de leitura a informações públicas de pedágio e concessionárias",
              "write:consultas": "Execução de consultas em lote e validações de veículos"
            }
          }
        }
      },
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Token JWT de autorização RFC 6750"
      }
    }
  },
  "externalDocs": {
    "description": "Documentação da API do Pedágio Eletrônico",
    "url": "https://www.pedagioeletronico.com.br/docs/"
  }
}