API dos Serviços Estaduais

Ministério da Gestão e da Inovação em Serviços Públicos - Secretaria de Governo Digital (MGI/SGD)

Versão 1.0 - 27/02/2025

API que viabiliza a integração de solução tecnológica do Estado com o Portal gov.br para carga e atualização de serviços presente em sua carta de serviços. Se o estado desejar, também poderá realizar a integração com a API de Acompanhamento e Avaliação para coletar avaliações dos usuários e apresentar as suas notas na página do serviço.

Público Alvo: Gestores de serviços estaduais

Legislação Associada:

Decreto nº 12.069, de 21 de junho de 2024 (Estratégia Nacional de Governo Digital).
Decreto nº 9.756, de 11 de abril de 2019 (Institui o portal único).

1. Autenticar

Realiza a autenticação para consumir os demais endpoints.

Atributo	Descrição de Negócio
Parâmetros de Entrada
email	E-mail utilizado como login para a autenticação
senha	Senha para a autenticação
Parâmetros de Saída
autorização	Token de autorização

2. Inserir um serviço

Insere um serviço na carta de serviços do estado no portal gov.br.

*Atributo*	*Descrição de Negócio*
*Parâmetros de Entrada*
authorization	Token de autorização
uf	Unidade da Federação
idCategoria	ID da categoria do serviço estadual
nomeServico	Nome do serviço estadual
siglaServico	Sigla do serviço estadual
descricaoServico	Descrição do serviço estadual disponibilizado
statusServico	Status do serviço (P = Publicado, R = Restrito, E = Excluído/Inativo)
tagsServico	Etiquetas que serão exibidas junto ao serviço estadual, separadas por '\|'
nomesPopulares	Nomes populares pelos quais o serviço é conhecido, separadas por '\|'
solicitanteServico	Público ao qual o serviço é destinado
url	Link para a página do serviço
linkServicoDigital	Link para o sitio onde o serviço é disponibilizado
cidade	Cidade à qual o serviço está vinculado
contato	Contato para obter mais informações sobre o serviço.
idServicoOrigem	Id do serviço no sistema de origem. Campo utilizado para facilitar a integração com sistemas estaduais.

3. Editar um serviço

Edita os parâmetros de um serviço na carta de serviços do estado no portal gov.br

*Atributo*	*Descrição de Negócio*
*Parâmetros de Entrada*
authorization	Token de autorização
uf	Unidade da Federação
idCategoria	ID da categoria do serviço estadual
nomeServico	Nome do serviço estadual
siglaServico	Sigla do serviço estadual
descricaoServico	Descrição do serviço estadual disponibilizado
statusServico	Status do serviço (P = Publicado, R = Restrito, E = Excluído/Inativo)
tagsServico	Etiquetas que serão exibidas junto ao serviço estadual, separadas por '\|'
nomesPopulares	Nomes populares pelos quais o serviço é conhecido, separadas por '\|'
solicitanteServico	Público ao qual o serviço é destinado
url	Link para a página do serviço
linkServicoDigital	Link para o sitio onde o serviço é disponibilizado
cidade	Cidade à qual o serviço está vinculado
contato	Contato para obter mais informações sobre o serviço.
idServicoOrigem	Id do serviço no sistema de origem. Campo utilizado para facilitar a integração com sistemas estaduais.

4. Consultar serviço

Consulta um serviço estadual na carta de serviços do estado no portal gov.br.

Atributo	Descrição de Negócio
Parâmetros de Entrada
authorization	Token de autorização
idServico	Identificador único do serviço estadual
Parâmetros de Saída
uf	Unidade da Federação
idCategoria	ID da categoria do serviço estadual
nomeServico	Nome do serviço estadual
siglaServico	Sigla do serviço estadual
descricaoServico	Descrição do serviço estadual disponibilizado
statusServico	Status do serviço (P = Publicado, R = Restrito, E = Excluído/Inativo)
tagsServico	Etiquetas que serão exibidas junto ao serviço estadual, separadas por '\|'
nomesPopulares	Nomes populares pelos quais o serviço é conhecido, separadas por '\|'
solicitanteServico	Público ao qual o serviço é destinado
url	Link para a página do serviço
linkServicoDigital	Link para o sitio onde o serviço é disponibilizado
cidade	Cidade à qual o serviço está vinculado
contato	Contato para obter mais informações sobre o serviço.
idServicoOrigem	Id do serviço no sistema de origem. Campo utilizado para facilitar a integração com sistemas estaduais.
etapasServicoEstadual	Etapas do serviço estadual

TECNOLOGIAS

REST JSON