Documentação da API do Guia de Serviços

Este documento é referente a versão v1 da api do Guia de Serviços.
A api v1 está disponível no endereço www.servicos.al.gov.br/api/v1/"sessão-que-deseja". Esta "sessão-que-deseja" está referindo-se aos conteúdos em services.json, organs.json e units.json. O endereço apresentado é a forma genérica para acessar a listagem de cada uma das sessões mensionadas.

Services.json

A sessão de serviços é apresentada no endereço www.servicos.al.gov.br/api/v1/services.json, onde serão listados os serviços por id do serviço, nome do serviço, descrição do serviço, o endereço do serviço no sitema e o órgão responsável por tal serviço.

Descrição dos Serviços

Para descrever um determinado serviço é preciso que seja usado o endereço www.servicos.al.gov.br/api/v1/services/"id_do_serviço".json.

O "id_do_serviço" é o id do serviço que é apresentado na listagem dos serviços uma sessão anterior.

A descrição do serviço retorna o id, name , active (este campo informa se o serviço está ativo no sistema), popular_names (são os nomes populares para a identificação do serviço.), description, free (se tem custos para o cidadão na prestação do serviço), url (o endereço do serviço no guia de serviços), permalink, steps (passos para a prestação de serviços), applicants (retorna quem pode solicitar o serviço) e dentro deste key tem as compontenes {type,requirements,other_informations } (estes keys trazem as informações sobre o tipo de requerente, o cenário em que se deve solicitar o serviço e outras informações complementares), estimated_time (retorna o tempo estimado para realizar o serviço), organ, categories (que representa as categorias que o serviço se enquadra) { possui id e name}, audiences (retorna o público álvo {possui id e name}).

Filtros para pesquisa mais detalhada na página inicial dos Serviços

A sessão possui filtros para melhorar a busca por informações na api. Pode se fazer filtros por ocorrência de um conjunto de caracteres, é uma pesquisa genérica, pode filtrar por órgão fazendo uso da id do mesmo, filtrar por ocorrência de uma letra ou se o serviço está ativo.

Filtros por ocorrência de um conjunto de caracteres se dá com o uso do parâmetro [q] no endereço dado http://localhost:3000/api/v1/services.json?q=pesquisa_por_subpalavra, esta combinação retornará todas as ocorrências que possuam pesquisa_por_subpalavra no seu texto.

Filtros por id do órgão há com o endereço www.servicos.al.gov.br/api/v1/services.json?organ_id=id_do_orgao, é preciso passar o id do órgão, assim serão retornados os serviços daquele órgão cujo id foi fornecida na url.

Filtro através do uso ocorrência de uma letra ocorre com o endereço www.servicos.al.gov.br/api/v1/services.json?letter=letra_de_pesquisa, assim serão retornadas as ocorrências da letra fornecida no nome dos srviços.

Filtro por ativo retorna a relação dos serviços por estatus de ativo através do endereço www.servicos.al.gov.br/api/v1/services.json?active=true ou false.

Units.json

A sessão de unidades de atendimento traz uma lista com o id e o name das unidades de atendimento registradas no sistema.

Descrição das Unidades de Atendimento

Com acesso à descrição, no endereço www.servicos.al.gov.br/api/v1/units/"id_da_unidade".json, é possível acesso às chaves id, name, address, phone, email, coordinates {latitude e longitude}, schedules {day, start e end}, permalink, url, service_ids (retorna os ids dos serviços prestados nesta unidade de atendimentos), organ.

Caso deseje-se um pouco de detalhes dos serviços prestados na determinada unidade selecionada com o id, terá atravez do endereço www.servicos.al.gov.br/api/v1/units/"id_da_unidade".json?show_services=true, este endereço fornecerá organ_id, unit_id, services com as listas das chaves {service_id, name, description, categories{id, name}}, esta descrição vem para todos os serviços por tal unidade de atendimento prestados.


Filtros para pesquisa mais detalhada na página inicial das unidades de atendimento

A sessão possui filtros para melhorar a busca por informações na api. Pode se fazer filtros por ocorrência de um conjunto de caracteres, é uma pesquisa genérica, pode filtrar por órgão fazendo uso da id do mesmo, filtrar por ocorrência de uma letra ou pelo município.

Filtros por ocorrência de um conjunto de caracteres se dá com o uso do parâmetro [q] no endereço dado www.servicos.al.gov.br/api/v1/units.json?q=pesquisa_por_subpalavra, esta combinação retornará todas as ocorrências que possuam pesquisa_por_subpalavra no seu texto.

Filtros por id do órgão há com o endereço www.servicos.al.gov.br/api/v1/units.json?organ_id=id_do_orgao, é preciso passar o id do órgão, assim serão retornados as unidades daquele órgão cujo id foi fornecida na url.

Filtro através do uso ocorrência de uma letra ocorre com o endereço www.servicos.al.gov.br/api/v1/units.json?letter=letra_de_pesquisa, assim serão retornadas as ocorrências da letra fornecida no nome das unidades de atendimento.

Filtro por município retorna a relação das unidades de atendimento por munícipio através do endereço www.servicos.al.gov.br/api/v1/units.json?county=nome_do_município.

Organs.json

Os prestadores de serviços, aqui denominados como órgãos, são listados mostrando id, name,active, acronym e nature.

Descrição dos Órgãos

Para atender à necessidade descritiva dos órgãos o endereço www.servicos.al.gov.br/api/v1/organs/"id_do_orgao".json atende tal requisião com o retorno de id, name, county, address, acronym, phones, emails, image, nature, coordinates{latitude, longitude}, permalink, url, schedules, popular_names, service_ids, units_ids.
Filtros para pesquisa mais detalhada na página inicial dos Órgãos

A sessão possui filtros para melhorar a busca por informações na api. Pode se fazer filtros por ocorrência de um conjunto de caracteres, é uma pesquisa genérica, pode filtrar por órgão fazendo uso da id do mesmo, filtrar por ocorrência de uma letra, pelo município, pelo acrônimo e pela natureza do órgão.

Filtros por ocorrência de um conjunto de caracteres se dá com o uso do parâmetro [q] no endereço dado http://www.servicos.al.gov.br/api/v1/organs.json?q=pesquisa_por_subpalavra, esta combinação retornará todas as ocorrências que possuam pesquisa_por_subpalavra no seu texto.

Filtros através do uso ocorrência de uma letra ocorre com o endereço http://www.servicos.al.gov.br/api/v1/organs.json?letter=letra_de_pesquisa, assim serão retornadas as ocorrências da letra fornecida no nome dos órgãos.

Filtros pela natureza do órgão retorna a relação dos órgãos por munícipio através do endereço http://www.servicos.al.gov.br/api/v1/organs.json?nature=natureza_do_orgao.

Filtros por Acrônimos o órgão representado por dado acrônimo através do endereço http://www.servicos.al.gov.br/api/v1/organs.json?acronym=acronimo.

Centers.json

As centrais Já! reune unidades de atendimentos de divérsos órgãos e que atende à sociedade com diversos serviços, estas centrais Já! são listadas no sistema com id e name.

Descrição das Centrais de Atendimento Já!

Cada uma das centrais já! são descritas com id, name, address, phones, email, coordinates, schedules, permalink, url, units, services_units, através do endereço www.servicos.al.gov.br/api/v1/centers.json. Para ter as informações de cada uma das centrais já! individualmente usa o endereço www.servicos.al.gov.br/api/v1/centers/"id_da_central".json.