¶ ¶ Endpoint: Convênios (GET /api/v1/convenios)
Este endpoint da API Públicas - CGE permite consultar convênios registrados no Portal da Transparência. A operação é do tipo GET, utilizada para leitura de dados, retornando as informações em formato JSON.
¶ ¶ Como funciona
- Método: GET
- Rota:
/api/v1/convenios - Parâmetros: enviados via query
- Paginação: obrigatória
- Retorno: JSON com lista de convênios
¶ ¶ Exemplo de requisição
https://transparencia.api.ro.gov.br/api/v1/convenios?page=1&pageSize=10
Exemplo filtrando por período:
https://transparencia.api.ro.gov.br/api/v1/convenios?DataInicioAssinatura=2024-01-01&DataFimAssinatura=2024-12-31&page=1&pageSize=10
¶ ¶ Parâmetros de consulta
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| DataInicioAssinatura | date | Filtra convênios a partir da data. | 2024-01-01 |
| DataFimAssinatura | date | Filtra convênios até a data. | 2024-12-31 |
| CodigoUnidade | int | Código da unidade. | 123 |
| Cpf_Cnpj | string | CPF ou CNPJ. | 12345678000199 |
| RazaoSocial | string | Nome da entidade. | Empresa X |
| Objeto | string | Descrição do convênio. | cooperação |
| NumeroContrato | string | Número do convênio. | 28/2024 |
| page | int | Página | 1 |
| pageSize | int | Quantidade por página | 10 |
¶ ¶ Onde visualizar as respostas
Após preencher os parâmetros e clicar em Execute no Swagger, a resposta da API será exibida logo abaixo do endpoint.
- Parâmetros utilizados
- URL gerada
- Resposta em JSON
- Lista de convênios retornados
O retorno exibido apresenta os convênios conforme os filtros informados, permitindo a visualização imediata dos dados.
As imagens abaixo demonstram onde a resposta aparece no Swagger.