API do CidadES
Ei você, jurisdicionado que envia as remessas ao CidadES, sabia que existe um jeito de automatizar as conferências e envios das informações? Com a API do CidadES, você pode agilizar, e muito, a sua rotina!
O uso da API requer um apoio da equipe de TI do órgão, pois envolve a criação de integrações entre os sistemas locais e o CidadES. Mas esse é um investimento que vale a pena, pois a automação reduz erros, economiza tempo e moderniza a gestão como um todo. Com a API, o trabalho fica mais ágil e confiável, trazendo ganhos reais para a rotina da unidade gestora.
A API permite que os sistemas usados pelos órgãos e entidades conversem diretamente com o sistema do Tribunal, sem precisar acessá-lo manualmente. Assim, tarefas como consultar informações, enviar dados e atualizar registros podem ser feitas de forma automática, com segurança e precisão.
Atualmente, já é possível fazer muitas coisas. Algumas delas são:
- Consultar as informações dos atos de admissão e concessão de benefícios;
- Consultar, cadastrar, atualizar e excluir contratações;
- Consultar unidades gestoras e responsáveis.
- E muito mais!
A API está em constante evolução! O Tribunal está sempre aprimorando a ferramenta e estamos abertos à sugestão sobre novas operações que possam facilitar ainda mais o dia a dia de quem utiliza o sistema, então se você quer que uma funcionalidade seja adicionada à API, abra um chamado com a sua sugestão!
Para começar a usar a API, o gestor da UG deve a habilitar e gerar os dados de autenticação.
Para habilitar, como gestor:
1. Clique em Unidade Gestora, no menu lateral;
2. Escolha a UG que deseja utilizar a API e clique nas Ações;
3. Selecione a opção Integrações;
4. No menu que aparece, clique em Adicionar;
Serão mostrados os dados utilizados no código para conectar com a API, incluindo o Client secret. É muito importante que não se compartilhe essas informações, pois elas funcionam como um “login e senha” para acessar a API como sua UG. Aqui, você pode configurar a descrição dessa chave de integração e se ela poderá ser utilizada para resgatar os dados ou também enviar dados ao Tribunal.
5. Após salvar esses dados em um local seguro, clique em Salvar;
Na página de integrações, você poderá ver as informações de todas as suas chaves (com exceção do Client secret, que deve ser salvo durante a criação da chave) e excluir as integrações.
De posse das informações geradas ao habilitar a API, cada UG poderá consultar somente seus próprios dados, garantindo a segurança das informações. Já as UGs agregadoras vão poder visualizar os dados de todas as UGs que estiverem sob sua responsabilidade.
O segredo (ou “Client secret”) utilizado na configuração não expira, mas pode ser renovado a qualquer momento na mesma tela onde a integração foi criada. Se houver mudança de gestor, o novo responsável será avisado sobre a opção de renovar o segredo, garantindo que o acesso permaneça seguro e controlado.
Após habilitar a integração, o seu sistema poderá enviar e receber informações diretamente do CidadES por meio dos endereços disponíveis na documentação da API. Essas informações serão úteis na hora da integração do sistema, feita pela equipe de TI responsável.
Cada ponto de acesso está documentado, mostrando:
- quais informações podem ser consultadas ou enviadas;
- os códigos de resposta (como sucesso, erro de autenticação);
- e os detalhes de cada campo (schemas), descritos no final da página.
Assim, você tem tudo o que precisa para configurar corretamente a integração e aproveitar ao máximo as funcionalidades da API.
