API
Seguindo atuais tendências tecnológicas e em resposta às demandas dos nossos jurisdicionados, apresentamos a API do sistema CidadES. Esta nova facilidade permite o envio e recebimento de dados entre os sistemas dos jurisdicionados do TCEES e o sistema CidadES, viabilizando a automação de tarefas até então realizadas de forma manual por aqueles que prestam contas ao Tribunal. Com isso, há ganhos de produtividade e diminui-se a incidência de erros de operação.
Nesta fase inicial, você pode realizar as seguintes operações:
- Consultar o status das remessas;
- Consultar informações sobre todas as contratações ou apenas uma, a partir do identificador da contratação;
- Realizar operações de cadastro, atualização e exclusão de contratações;
- Consultar todas as unidades gestoras ou apenas uma, a partir do identificador único;
- Consultar os responsáveis pelas UG’s e suas obrigatoriedades.
Estamos comprometidos com o aprimoramento contínuo da API do CidadES e planejamos adicionar mais operações no futuro para atender às necessidades dos nossos jurisdicionados.
Para começar o uso, o gestor da UG deve habilitar a API e gerar os dados de autenticação.
Para habilitar:
1. O gestor da UG deve entrar no ambiente de validação;
2. Clique no menu Unidade Gestora;
3. Encontre a UG que deseja habilitar a API e, no menu de Ações, clique em Integrações;
Figura 01 – Localização da opção “Integrações”
4. Clique em Gerar chave;
Figura 02 – Localização da opção “Gerar chave”
5. Será gerado um secret. Passe ao desenvolvedor que testará a API: o client id, client secret e o link da documentação.
A conexão adota o modelo de client-credentials (credenciais únicas para cada usuário). Dessa forma, a requisição de autenticação será realizada com as credenciais fornecidas pelo gestor da UG. Com essas credenciais, deve-se gerar um token que permitirá o acesso aos demais endpoints.
É importante ressaltar que cada UG terá acesso apenas aos seus próprios dados, enquanto as UGs agregadoras poderão visualizar informações de todas as UGs sob sua agregação.
O secret utilizado na configuração da API não possui prazo de validade. No entanto, é possível renová-lo diretamente na mesma tela onde a API foi habilitada. Caso ocorra a substituição do gestor, ele receberá um aviso sobre a opção de renovação do segredo.
Todos os pontos de acesso estão devidamente documentados na API, incluindo os códigos de resposta, o conteúdo das respostas de cada solicitação e outras informações relevantes. Além disso, no final da página, você encontrará os schemas que descrevem cada campo presente nos respectivos endpoints.
É possível utilizar o ambiente de validação do CidadES para realizar os testes da API. Acesse a documentação desse ambiente!
