API-GUIA-SERVICOS

De SEADE
Edição feita às 15h12min de 24 de outubro de 2016 por Luiza (disc | contribs)

Ir para: navegação, pesquisa

Índice

Apresentação

A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações que tornem possível a visualização de informações dos serviços públicos em outros sítios, ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações sempre atualizadas do Guia de Serviços. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.

URI 

http://api-guiaserv.seade.gov.br/v1

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.

Recursos Disponíveis

Órgãos

GET


  • Path: /orgao/
  • Parâmetros: id

É necessário informar o "id" (código) ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/all"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/orgao/{id}"

Retorno JSON

Exemplo: 

{
 "orgao": [
   {
     "Nome": "Procuradoria Geral do Estado",
     "ID_Orgao": "35",
     "Condicao": "1"
   }
 ]
}

  Obs.: Condicao = 1 (órgao ativo) e Condicao = 0 (órgão inativo)

Prestadores

GET


  • Path: /prestador/
  • Parâmetros: id

É necessário informar o "id" (código) ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/prestador/all"

ou 

curl -X GET http://api-guiaserv.seade.gov.br/v1/prestador/{id}"

Retorno JSON

Exemplo: 


{
 "prestador": [
   {
     "ID_Prestador": "310",
     "Nome": "Procuradoria Geral do Estado - Sede",
     "ID_Orgao": "35",
     "Nome_Secretaria": "Procuradoria Geral do Estado",
     "Endereco": "Rua Pamplona",
     "EndNumero": "227",
     "EndComplemento": "6º andar",
     "CEP": "01405902",
     "Municipio_IBGE": "3550308",
     "Nome_Municipio": "São Paulo",
     "Telefone": "11-3372-6438",
     "Ramal": null,
     "Fax": "11-3372-6498",
     "HomePage": "www.pge.sp.gov.br",
     "Email": "arinaldi@sp.gov.br",
     "Condicao": "1"
   }
 ]
}

Obs.: Condicao = 1 (prestador ativo) e Condicao = 0 (prestador inativo)

Municípios

GET


  • Path: /municipio/
  • Parâmetros: id

É necessário informar o "id" (código) ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/all"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/municipio/{id}"

Retorno JSON

Exemplo: 

{
 "muncipio": [
   {
     "Municipio_IBGE": "3550308",
     "Nome": "São Paulo"
   }
 ]
}

Ouvidorias

GET


  • Path: /ouvidoria/
  • Parâmetros: id

É necessário informar o "id" (código do prestador) ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidoria/all"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidoria/{id}"

Retorno JSON

Exemplo: 

{
 "ouvidoria": [
   {
     "ID_Prestador": "310",
     "ID_Informante": "38",
     "Nome": "Maria Rita Vaz de Arruda Corsini",
     "Telefone": "11-3372-6405",
     "Ramal": null,
     "Email": "ouvidoria@sp.gov.br",
     "Fax": "11-3372-6406",
     "HomePage": "http://www.ouvidoria.sp.gov.br/RegistraManifestacao.aspx?cod_prestador=310",
     "Endereco": "Rua Pamplona",
     "EndNumero": "227",
     "EndComplemento": "1º andar",
     "CEP": "01405902",
     "Municipio_IBGE": "3550308",
     "Nome_Municipio": "São Paulo",
     "AtendInicio": "10:00",
     "AtendFim": "16:00",
     "Condicao": "2"
   }
 ]
}

Obs.: Condicao = 2 (ouvidor ativo) e Condicao = 1 (ouvidor inativo)

Ouvidores

GET


  • Path: /ouvidor/
  • Parâmetros: id

É necessário informar o "id" (código) ou a palavra "all" para listar todos os registros.


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidor/all"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/ouvidor/{id}"

Retorno JSON

Exemplo: 

{
 "ouvidor": [
   {
     "ID_Informante": "38",
     "ID_Usuario": "235",
     "Nome": "Maria Rita Vaz de Arruda Corsini",
     "Cargo": "Ouvidora",
     "Gerencia": "Ouvidoria",
     "Telefone": "11-3372-6493",
     "Ramal": "",
     "Fax": "11-3372-6406",
     "Email": "mcorsini@sp.gov.br,tari@uol.com.br"
   }
 ]
}

Serviços

GET

Use o formato abaixo para buscar uma variável por requisição.

  • Path: /servico/
  • Parâmetros: id

Para buscar um serviço específico é necessário informar o "id" (código).

Para buscar todos os serviços, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo:

  • Path: /servico/offset={inicial}/limit={limite}


Sintaxe de chamada 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/offset=0/limit=10"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/{id}"

Retorno JSON

Exemplo: 


{
 "servico": [
   {
     "Nome": "Indenização Administrativa de Danos Causados por Agentes do Estado - Procuradoria Geral do Estado",
     "ID_Servico": "1302",
     "ID_Orgao": "35",
     "Nome_Secretaria": "Procuradoria Geral do Estado",
     "ID_Prestador": "310",
     "Nome_Orgao": "Procuradoria Geral do Estado - Sede",
     "Descricao": "Indenização administrativa de danos causados por agentes do Estado. Avalia-se a possibilidade de acordo administrativo sobre indenização de danos, desde que o pretendente não tenha ação judicial veiculando 
      a mesma pretensão indenizatória.",
     "Condicao": "1"
   }
 ]
}

Obs.: Sempre será listado o serviço de Condicao = 1 (registro da última atualização)

Serviços detalhados

GET

Use o formato abaixo para buscar uma variável por requisição.

  • Path: /servico/detalhado/
  • Parâmetros: id


Para buscar um serviço específico é necessário informar o "id" (código).

Para buscar todos os serviços, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo:

  • Path: /servico/detalhado/offset={inicial}/limit={limite} 


curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/detalhado/offset=0/limit=10"

ou 

curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/detalhado/{id}"

Retorno JSON

Exemplo: 

   {
    "header": {
    "serviços": "833",
    "offset": "138",
    "limite": "1"
     },
    "servico": [
     {
     "Nome do serviço": "Indenização Administrativa de Danos Causados por Agentes do Estado - Procuradoria Geral do Estado",
     "ID_Servico": "1302",
     "ID_Orgao": "35",
     "Nome_Secretaria": "Procuradoria Geral do Estado",
     "ID_Prestador": "310",
     "Nome_Prestador": "Procuradoria Geral do Estado - Sede",
     "Serviços que possuem informações em homepage": "Não",
     "URL da homepage": null,
     "Serviços que oferecem informações por e-mail": "Não",
     "Descrição do e-mail": null,
     "Serviços que oferecem informações por formulário eletrônico": "Não",
     "URL do formúlario eletrônico": null,
     "Serviços que oferecem informações por telefone": "Sim",
     "Número do Telefone 1": "(11) 3372-6414 - Procurador Instrutor",
     "Número do Telefone 2": null,
     "Número do Telefone 3": null,
     "Serviços que oferecem informações por correspondência": "Sim",
     "Serviços que oferecem informações no próprio órgão": "Sim",
     "Serviço que possuem informações disponibilizadas através do Poupatempo ": "Não",
     "Serviços que oferecem informações em instituições credenciadas": "Não",
     "Serviços que oferecem informações em domicílio ": "Não",
     "Serviços que oferecem informações em Escritórios Regionais/Postos de Atendimento ": "Não",
     "Serviços que oferecem informações de outras formas": "Não",
     "Serviços que são prestados por homepage": "Não",
     "Serviços realizados parcialmente pela Internet (somente formulários)": null,
     "Serviços que são prestados por formulário": "Não",
     "Serviços que são prestados por telefone": "Não",
     "Serviços que são prestados por correspondência": "Não",
     "Endereço para correspondência": "Rua Pamplona, 227 - 17º andar",
     "Cep para correspondência": "01405902",
     "Código Município para correspondência": "3550308",
     "Serviços que são prestados no próprio órgão": "Sim",
     "Serviço que são prestados no Poupatempo ": "Não",
     "Serviços que são prestados em instituições credenciadas": "Não",
     "Serviços que são prestados em domicílio": "Não",
     "Serviços que são prestados em Escritórios Regionais/Postos de Atendimento ": "Não",
     "Serviços que são prestados por outras formas": "Não",
     "Descrição das outras formas de serviços": null,
     "Cobrança para execução do serviço?": "Não gratuito",
     "Tipo de cobranças": null,
     "Alvo do serviço": "Cidadão e Empresa",
     "Descricao": "Indenização administrativa de danos causados por agentes do Estado. Avalia-se a possibilidade de acordo administrativo sobre indenização de danos, desde que o pretendente 
          não tenha ação judicial veiculando a mesma pretensão indenizatória.",
     "Data da disponibilização": "2016-04-08 14:43:17"
     }
    ]
   }

Serviços detalhados por Órgão

GET

Use o formato abaixo para buscar uma variável por requisição.

Para buscar todos os serviços do Órgão , é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo:

  • Path: /servico/detalhado/orgao/{id}/offset={inicial}/limit={limite} 


curl -X GET "http://api-guiaserv.seade.gov.br/v1/servico/detalhado/orgao/11/offset=0/limit=20"


Retorno JSON

Exemplo: 


 "header": {
   "serviços": "6",
   "paginas": 1,
   "offset": "0",
   "limite": "10"
 },
 "servico": [
   {
     "Nome do serviço": "Ouvidoria - Secretaria da Administração Penitenciária",
     "ID_Servico": "1",
     "ID_Orgao": "11",
     "Nome_Secretaria": "Secretaria da Administração Penitenciária",
     "ID_Prestador": "1",
     "Nome_Prestador": "Secretaria da Administração Penitenciária - Sede",
     "Serviços que possuem informações em homepage": "Sim",
     "URL da homepage": "www.sap.sp.gov.br/ouvidoria.html",
     "Serviços que oferecem informações por e-mail": "Sim",
     "Descrição do e-mail": "ouvidoria@sap.sp.gov.br",
     "Serviços que oferecem informações por formulário eletrônico": "Não",
     "URL do formúlario eletrônico": null,
     "Serviços que oferecem informações por telefone": "Sim",
     "Número do Telefone 1": "(11) 3775-8103",
     "Número do Telefone 2": "(11) 3775-8126",
     "Número do Telefone 3": "(11)  3775-8122",
     "Serviços que oferecem informações por correspondência": "Sim",
     "Serviços que oferecem informações no próprio órgão": "Sim",
     "Serviço que possuem informações disponibilizadas através do Poupatempo ": "Não",
     "Serviços que oferecem informações em instituições credenciadas": "Não",
     "Serviços que oferecem informações em domicílio ": "Não",
     "Serviços que oferecem informações em Escritórios Regionais/Postos de Atendimento ": "Não",
     "Serviços que oferecem informações de outras formas": "Não",
     "Serviços que são prestados por homepage": "Não",
     "Serviços realizados parcialmente pela Internet (somente formulários)": null,
     "Serviços que são prestados por formulário": "Não",
     "Serviços que são prestados por telefone": "Sim",
     "Serviços que são prestados por correspondência": "Sim",
     "Endereço para correspondência": "Rua Líbero Badaró, 600 - 4º andar",
     "Cep para correspondência": "01008000",
     "Código Município para correspondência": "3550308",
     "Serviços que são prestados no próprio órgão": "Sim",
     "Serviço que são prestados no Poupatempo ": "Não",
     "Serviços que são prestados em instituições credenciadas": "Não",
     "Serviços que são prestados em domicílio": "Não",
     "Serviços que são prestados em Escritórios Regionais/Postos de Atendimento ": "Não",
     "Serviços que são prestados por outras formas": "Não",
     "Descrição das outras formas de serviços": null,
     "Cobrança para execução do serviço?": "Não gratuito",
     "Tipo de cobranças": null,
     "Alvo do serviço": "Cidadão",
"Descricao": "

A Ouvidoria da SAP existe para assegurar aos cidadãos presos o respeito a seus direitos básicos. Permite ao preso, diretamente ou por seus familiares, registrar sua ...

", 
     "Data da disponibilização": "2016-07-06 10:49:27"
   },
   ....
Disponível em "http://doc.seade.gov.br/index.php?title=API-GUIA-SERVICOS&oldid=204"