O Portal gov.br atualmente armazena e disponibiliza serviços de origem federal e estadual.
A manutenção destes serviços junto à plataforma é feita pelos seus gestores, apontados por cada órgão responsável. Por questões técnicas, o processo é diferente para cada esfera.
Para os serviços estaduais, é necessário que as operações sejam realizadas por meio de requisições em API REST. Os serviços serão apresentados na seção Serviços Estaduais, na página (https://www.gov.br/pt-br/servicos-estaduais).
ORIENTAÇÕES
Para realizar a manutenção dos serviços do estado, o gestor responsável precisa solicitar as credenciais de acesso. Acesse o link abaixo, faça login com sua conta gov.br e siga as instruções apresentadas. O resultado será enviado para o e-mail cadastrado.
Existem atualmente três APIs disponíveis para realizar a gestão dos serviços estaduais, que serão apresentadas abaixo. Detalhes dos parâmetros e exemplos de requisições estão disponíveis em cada endpoint, nas opções 'Model' e 'Example value', respectivamente.
API de Serviços
Armazena os dados dos serviços e expõe endpoints para as operações CRUD (Criar, Ler, Atualizar e Deletar). O grupo de endpoints a ser utilizado pelos Estados é o SERVICO ESTADUAL.
API de Acompanhamento
Cada interação do cidadão com o serviço deve gerar um acompanhamento. Essa API atua como um repositório para esses registros, disponibilizando endpoints para a criação e consulta dos dados de acompanhamento.
API de Avaliação
Armazena e gerencia avaliações de serviços, oferecendo endpoints para criação e consulta. Cada avaliação está vinculada a um registro de acompanhamento.
Para as APIs de Acompanhamento e Avaliação, está disponível o passo a passo abaixo:
Recomendamos realizar testes usando a ferramenta Postman ou o próprio Swagger antes de iniciar a integração completa das APIs, para familiarizar-se com os endpoints e garantir um processo mais suave. Após cada requisição na API de Produção, é possível consultar as suas alterações no Portal gov.br (https://www.gov.br/pt-br/servicos-estaduais) para o estado desejado.
Atenção: Existe uma cache no portal gov.br quando o acesso é feito sem autenticação com a conta gov.br. Caso realize alguma alteração em um serviço, faça o login no portal para consultar a atualização em tempo real.
Para referência, apresentamos abaixo a relação entre API e Portal gov.br para os campos abaixo:
As categorias disponíveis para uso nos serviços estaduais são as mesmas dos serviços federais. Para consultar quais são, utilize o grupo de endpoints CATEGORIAS.
Após realizar todos os testes, todos os serviços do estado podem ser carregados na API.
O gestor do estado será responsável por manter os dados dos serviços atualizados e funcionais. Caso sejam implementadas evoluções nas funcionalidades da API ou do Portal gov.br que tenham impacto nos serviços estaduais, os gestores serão notificados por e-mail com antecedência para que possam realizar os ajustes necessários.
Atenção! Caso sejam identificadas inconsistências, erros ou informações que violem leis ou outros normativos oficiais, os serviços dos estados podem ser alterados pela equipe gov.br sem aviso prévio.
Caso o gestor do estado tenha alguma dúvida ou dificuldade durante o uso da API ou do Portal gov.br, poderá registrar uma solicitação abaixo: