api-consulta

e-Agendas - API Consulta

Esta é uma API pública, disponível para qualquer cidadão.

URL da API

• Ambiente de Produção: https://eagendas.cgu.gov.br/api/v2
• Ambiente de Treinamento: https://eagendastreinamento.cgu.gov.br/api/v2

Pré-requisitos

• Token de acesso

Para utilizar a API, é necessário um token. Siga as instruções abaixo para gerar seu próprio token:

1. Faça login no sistema

2. Acesso a página de perfil do usuário

3. Acesse o menu 'Meus tokens' e gere um novo token

Lembre-se de guardar esse token, pois ele não poderá ser mostrado novamente.

Testes

É possível testar a API por meio do swagger ou qualquer sistema de teste de API, ou ainda diretamente usando curl.

Swagger

Para utilizar o swagger, siga os passos abaixo:

1. Acessar a documentação por meio da página (/api/docs): https://eagendas.cgu.gov.br/api/docs

2. Autorize o acesso utilizando o token do usuário, conforme instruções abaixo:

• Clique em Authorize:

• Insira o token no campo 'value' e clique em 'Authorize'

[IMPORTANTE] O swagger utiliza o ambiente de Treinamento, portanto o token que deve ser utilizado aqui deve ser criado no ambiente de treinamento.

3. Teste uma requisição:

• clique na requisição desejada e clique em 'Try it out':

• Clique em 'Execute'

Postman

Você também pode utilizar o Postman, que oferece uma versão pessoal gratuita, para testar a API do e-Agendas.

Para facilitar os testes, disponibilizamos arquivos a serem importados no Postman:

• Variáveis
• Rotas da API

Siga os passos abaixo para importar e configurar o Postman:

1. Importe os arquivos

• Clique em 'import':

• Cole a * URLs nesta caixa:

  

[IMPORTANTE] Siga o passo para cada uma das URLs abaixo:

• https://raw.githubusercontent.com/cgugovbr/eagendas-publico/main/api-consulta/postman/e-Agendas%20-%20treinamento%20-%20v2.postman_environment.json
• https://raw.githubusercontent.com/cgugovbr/eagendas-publico/main/api-consulta/postman/e-Agendas%20-%20v2%20-%20Consulta.postman_collection.json

2. Cole seu token no campo abaixo e clique em 'save':

3. Teste uma requisição

• Selecione a variável que foi importada

• Escolha uma requisição para teste e clique em 'Send'

Curl

Para testar a API via curl, utilize o código abaixo com o seu token de acesso.

curl -XGET https://eagendastreinamento.cgu.gov.br/api/v2/objetivos-compromissos -H "Accept: application/json" -H "Authorization: Bearer SEU_TOKEN_AQUI"

Caso tenha um jq instalado para visualizar os dados forma mais clara poderia utilizar "| jq" ao final: