4.3 - API´s e integrações

4.3.1 - Utilliza API em processos internos, de acordo com as atribuições do órgão setorial, com publicação do código da API no repositório central.

Detalhes do Critério

O que: Utilização de Interfaces de Programação de Aplicações (APIs), mantendo os códigos fonte no repositório central.

Por que: Para facilitar a integração entre sistemas internos, promover a reutilização de código e aumentar a eficiência dos processos. A publicação do código promove a transparência e a colaboração.

Onde: A utilização das APIs será feita nos processos internos que são atribuições do órgão setorial. O armazenamento do código fonte das APIs será no repositório central de códigos.

Quando: A qualquer momento, quando existir a possibilidade de implementação de APIs nos processos internos do órgão setorial. Depois de pronto realizar o armazenamento do código fonte da API no repositório central.

Quem: As equipes de desenvolvimento e arquitetura de sistemas do órgão setorial são responsáveis pela criação, utilização e publicação das APIs. Quando não, com a equipe de TIC participando na implentacão dessas solucões.

Como: Desenvolvendo APIs e integrando-as aos sistemas internos, seguindo os padrões para armazenamento no repositório central.

Quanto: Refere-se ao uso de APIs em processos internos e ao armazenamento dos códigos fontes.

4.3.2 - As APIs estão publicadas na vitrine de APIs, com códigos no repositório central.

Detalhes do Critério

O que: As APIs desenvolvidas pelo órgão setorial estão disponíveis para descoberta e utilização na vitrine de APIs, e seus códigos fontes estão armazenados no repositório central.

Por que: Para promover a interoperabilidade com outros órgãos ou sistemas externos, facilitar o desenvolvimento de novas soluções e aumentar a transparência.

Onde: Na vitrine de APIs e no repositório central de códigos.

Quando: As APIs são publicadas e mantidas na vitrine de forma contínua.

Quem: A equipe de TIC do órgão setorial é responsável pela publicação e manutenção das APIs na vitrine e no repositório central.

Como: Utilizando as ferramentas e processos definidos para publicação de APIs na vitrine e para o gerenciamento dos códigos no repositório central.

Quanto: Refere-se às APIs publicadas e seus códigos.

4.3.3 - Existe serviço digitalizado que utiliza API para execução e possui acesso público.

Detalhes do Critério

O que: Há pelo menos um serviço digital do órgão setorial que funciona utilizando uma API e essa API é acessível publicamente.

Por que: Para permitir que outros sistemas ou aplicações (de terceiros ou de outros órgãos) possam interagir com esse serviço digital, fomentando a interoperabilidade e a criação de novas soluções.

Onde: Nas plataformas digitais do órgão e na Vitrine de API.

Quando: A qualquer momento, quando existir a possibilidade de implementação de APIs nos processos do servico público prestado pelo órgão setorial.

Quem: A equipe de desenvolvimento do serviço digital e da API correspondente.

Como: Desenvolvendo o serviço digital utilizando a API e expondo a API de forma segura para acesso público na Vitrine.

Quanto: Pelo menos um serviço digital com API pública.

4.3.4 - Os serviços digitalizados utilizam API que possuem códigos no repositório central.

Detalhes do Critério

O que: Os serviços digitais do órgão setorial são implementados utilizando APIs, e os códigos dessas APIs estão armazenados no repositório central.

Por que: Para promover a arquitetura modular, facilitar a manutenção e evolução dos serviços, e permitir a reutilização de componentes de software. A publicação do código no repositório central contribui para a transparência e colaboração.

Onde: Nos sistemas que hospedam os serviços digitais e no repositório de códigos.

Quando: A qualquer momento, quando existir a possibilidade de implementação de APIs nos processos do servico público prestado pelo órgão setorial. Depois de pronto realizar o armazenamento do código fonte da API no repositório central.

Quem: As equipes de desenvolvimento dos serviços digitais e das APIs.

Como: Desenvolvendo os serviços em uma arquitetura baseada em APIs e seguindo os processos para armazenamento de código no repositório central.

Quanto: Refere-se à arquitetura dos serviços digitalizados e à disponibilidade dos códigos.

4.3.5 - As APIs publicadas na Vitrine possuem documentação atualizada.

Detalhes do Critério

O que: As APIs que o órgão setorial disponibiliza na Vitrine possuem documentação que está em dia e reflete o funcionamento atual das APIs.

Por que: Uma documentação atualizada é essencial para que desenvolvedores externos ou internos consigam entender e utilizar corretamente as APIs, facilitando a integração e o desenvolvimento de novas soluções.

Onde: Na própria vitrine de APIs, onde a documentação é disponibilizada.

Quando: A atualização da documentação deve ser um processo contínuo, acompanhando as mudanças nas APIs.

Quem: A equipe responsável pela manutenção das APIs e da Vitrine, incluindo a criação e atualização da documentação.

Como: Definindo processos para a criação e atualização da documentação sempre que as APIs forem modificadas.

Quanto: Refere-se à documentação das APIs publicadas.

4.3.6 - O órgão implementa a integração entre as bases de dados.

Detalhes do Critério

O que: O órgão realiza a integração de suas diferentes bases de dados.

Por que: Para obter uma visão mais completa e unificada dos dados, facilitar a análise, gerar relatórios mais precisos e melhorar a tomada de decisões. Também pode otimizar processos que dependem de informações de diferentes sistemas.

Onde: Nos servidores e sistemas que hospedam as diversas bases de dados do órgão setorial.

Quando: A implementação da integração é um projeto contínuo ou realizado em etapas. A manutenção da integração é constante.

Quem: A equipe de TIC, especialmente os administradores de banco de dados e desenvolvedores de sistemas.

Como: Utilizando ferramentas e técnicas de integração de dados, como ETL (Extract, Transform, Load) ou APIs para comunicação entre os bancos de dados.

Quanto: Refere-se à implementação da integração de forma geral.