API de Serviços — Catálogo de APIs governamentais

API de Serviços

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

Versão 1.0.0 - 13/07/2018

O Registro de Referência do Portal de Serviços Públicos foi instituído pela Resolução nº 9, de 22 de junho de 2022 do CCGD (Comitê Central de Governança de Dados), e tem a finalidade de:

promover a interoperabilidade do conjunto de dados entre entes governamentais;
auxiliar a formulação, a implementação, a avaliação, o monitoramento e a gestão de políticas públicas;
fomentar a qualidade e a fidedignidade dos dados custodiados pelos órgãos gestores de dados;
aumentar a eficiência e reduzir custos das operações internas dos sistemas de informação dos órgãos gestores e consumidores de dados; e
orientar o acesso aos órgãos e entidades de que trata o art. 1º ao conjunto de dados relacionados à Application Programming Interface - API do Portal de Serviços Públicos - API de Serviços, que compreende o canal oficial do Governo federal para divulgação das informações sobre os serviços públicos federais, em atendimento às finalidades previstas nos incisos I a VI do art. 1º do Decreto nº 8.936, de 19 de dezembro de 2016.

O Decreto nº 9.756/2019 instituiu o Portal gov.br como ferramenta centralizada para disponibilização de informações institucionais, notícias e serviços públicos prestados pelo Governo federal. Todas as informações e serviços de órgãos do Poder Executivo Federal devem estar disponíveis neste portal.

A API de Serviços fornece os dados do Portal gov.br, com informações sobre os serviços publicados, os órgãos, as etapas dos serviços, os contatos dos órgãos etc.

1. Consultar Órgão

Retorna todas as informações de um determinado órgão.

URL de requisição

https://www.servicos.gov.br/api/v1/orgao/codSiorg

Atributo	Descrição de Negócio
Parâmetros de Entrada
codSiorg	Identificador único do órgão a ser consultado
Parâmetros de Saída
id	Id do órgão no XML
dbld	Id do órgão no banco de dados
nomeOrgao	Nome do órgão
porcentagemDigital	Porcentagem de serviços 100% digitais do órgão
tempoMediaEspera	Tempo médio de espera de todos os serviços do órgão
porcentagemAvaliacoesPositivas	Percentual de avaliações positivas de todos os serviços do órgão
qtdTotal	Quantidade total de manifestações do formulário “Simplifique!” da Ouvidoria Geral da União
qtdTotalSolicitacoes	Quantidade de Solicitações de simplificação do formulário “Simplifique!” da Ouvidoria Geral da União
qtdDenuncias	Quantidade de Denúncias do formulário “Simplifique!” da Ouvidoria Geral da União
qtdReclamacao	Quantidade de Reclamações do formulário “Simplifique!” da Ouvidoria Geral da União

2. Consultar Serviço

Retorna todas as informações de um determinado serviço publicado.

URL de requisição

https://www.servicos.gov.br/api/v1/servicos/servicoId

Atributo	Descrição de Negócio
Parâmetros de Entrada
servicoId	Identificador único do serviço a ser consultado
Parâmetros de Saída
id	Endpoint para a busca do próprio Serviço
nome	Nome do Serviço
sigla	Sigla do Serviço
nomesPopulares	Nomes populares do serviço
descricao	Descrição do Serviço
contato	Meio de contato para saber mais sobre o Serviço prestado
gratuito	Indica se o Serviço é gratuito
porcentagemDigital	Porcentagem Digital do Serviço
tempoMediaEspera	Tempo médio estimado entre a solicitação do serviço e a entrega (dias corridos)
percentualAvaliacoesPositivas	Percentual de avaliações positivas
totalSimplifique	Quantidade total de manifestações do formulário “Simplifique!” da Ouvidoria Geral da União
simplifiqueSolicitacoes	quantidade de Solicitações de simplificação do formulário “Simplifique!” da Ouvidoria Geral da União
simplifiqueDenuncias	quantidade de Denúncias do formulário “Simplifique!” da Ouvidoria Geral da União
simplifiqueReclamacoes	quantidade de Reclamações do formulário “Simplifique!” da Ouvidoria Geral da União
servicoDigital	Indica se o Serviço é automatizado
linkServicoDigital	Link para o atendimento, caso o Serviço seja automatizado
tempoTotalEstimado	Tempo médio para entregar o serviço
validadeDocumento	Validade do documento obtido através do serviço
etapas	Etapas do serviço
orgao	Órgão prestador do serviço
palavrasChave	Palavras-chave do serviço
legislacoes	Legislação associada ao serviço
servicosRelacionados	Serviços relacionados ao serviço consultado
url	Url do serviço
condicoesAcessibilidade	Informações sobre as condições de acessibilidade, sinalização, limpeza e conforto dos locais de atendimento
tratamentoPrioritario	Informações sobre quem tem direito a tratamento prioritário
tratamentoDispensadoAtendimento	Tratamento a ser dispensado ao usuário no atendimento

3. Consultar todos os Serviços

Retorna informações de todos os serviços publicados.

URL de requisição

https://www.servicos.gov.br/api/v1/servicos/parametros

Atributo	Descrição de Negócio
Parâmetros de Entrada
Id, nome, sigla, ...	Parâmetros a serem consultados de todos os serviços
Parâmetros de Saída
Parâmetros de saída do serviço	Parâmetros a serem consultados de todos os serviços

TECNOLOGIAS

REST / JSON