Consulta de Serviços Públicos — Catálogo de APIs governamentais

Registros de Referência / Portal de Serviços gov.br

Consulta de Serviços Públicos

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

Base / Sistema: Portal gov.br

API externa

Federal

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.

Principais Operações

Consultar Órgão

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

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

nomeOrgao

Nome do órgão

codigoSiorg

Identificador único do órgão

codigoNaturezaJuridica

administração direta, indireta, etc

Consultar Serviço Completo

GET https://www.servicos.gov.br/api/v1/servicos/{servicoId}

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

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

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

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

etapas

Etapas do serviço

segmentosDaSociedade

Cidadãos ou empresas

areasDeInteresse

temas relacionados

orgao

Órgão prestador do serviço

palavrasChave

Palavras-chave do serviço

legislacoes

Legislação associada ao serviço

avaliacoes

quantidade de avaliações positivas ou negativas

url

url do Serviço

Consultar Serviço Simples

GET https://www.servicos.gov.br/api/v1/servicos/simples/{servicoId}

Parâmetros de Entrada servicoId

ID do Serviço para retorno

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

descricao

Descrição do Serviço

contato

Meio de contato para saber mais sobre o Serviço prestado

gratuito

Flag indicando se o Serviço é gratuíto

situacaoRegistro

Situação do registro

idOrgao

Identificador do órgão na base de dados

nomeOrgao

Nome do órgão

codigoSiorg

Código do órgão no SIORG

servicoDigital

Flag que define se o Serviço é automatizado

linkServicoDigital

Link para o atendimento, caso o Serviço seja automatizado

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

url

url do Serviço no Portal

flPortalLogado

Flag se o serviço será ou não exibido no portal logado

Consultar todos os Serviços (com autenticação)

GET https://www.servicos.gov.br/api/v1/servicos-auth

Parâmetros de Entrada Authorization

Token de autorização

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

temLoginGovBR

S ou N

temNivelMinimoContaGovBR

B, P ou O

temVerificacaoDuasEtapas

S ou N

utilizaAPIInteroperabilidade

S ou N

temInfoCIdadao

integracaoCidadao

servicoDigital

Indica se o Serviço é automatizado

linkServicoDigital

Link para o atendimento, caso o Serviço seja automatizado

solicitantes

Tipos de solicitante

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

segmentosDaSociedade

Cidadãos ou empresas

areasDeInteresse

temas relacionados

palavrasChave

Palavras-chave do serviço

legislacoes

Legislação associada ao serviço

avaliacoes

quantidade de avaliações positivas ou negativas

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

Endpoints

Produção

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

Para informações de uso, acesse https://www.servicos.gov.br/api/v1/docs.

FAQ - Acesse o link abaixo se está com problemas para acessar a API

https://www.gov.br/governodigital/pt-br/infraestrutura-nacional-de-dados/interoperabilidade/conecta-gov.br/acessar-os-servicos-do-conecta

Contato do Responsável

Coordenação-Geral de Automação e Atendimento (CGATE) - SGD/MGI

O canal de atendimento para suporte ou dúvidas deve ser solicitado por meio do seguinte link: https://gov.br/apiservicos

08:00 – 18:00 em dias comerciais