Documentação da API do Portal Alagoas Digital

Este documento é referente à primeira versão da API do Alagoas Digital. Essa API permite que desenvolvedores acessem informações do Portal Alagoas Digital. Você pode usar essa API para criar serviços privados ou aplicativos públicos. Para saber como obter suas informações e criar aplicativos privados/públicos, leia nossa documentação completa.

  • Versão: 3.0.0
  • Protocolos: https
  • Aceita: /json
  • Responde: /json
  • Autenticação: Não necessária

A sessão de serviços é apresentada no endereço /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.

Para descrever um determinado serviço é preciso que seja usado o endereço /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 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 /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 /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 /api/v1/services.json?q=letra_de_pesquisa , assim serão retornadas as ocorrências da letra fornecida no nome dos serviços.

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

A sessão de unidades de atendimento traz uma lista com o id e o name das unidades de atendimento registradas no sistema. E é apresentada no endereço /api/v1/units.json.

Com acesso à descrição, no endereço /api/v1/unit/"id_da_unidade".json, é possível acesso às chaves id, name, address, telephone, email, latitude, longitude, organ.

Os prestadores de serviços, aqui denominados como órgãos, são listados mostrando id, nome,ative, sigla e natureza. Encontrados no endereço /api/v1/organs.json.

Para atender à necessidade descritiva dos órgãos o endereço /api/v1/organs/"id_do_orgao".json atende tal requisição com o retorno de id, name, city, address, acronym, telephone, email, image, nature, latitude,longitude.

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.

Filtros por ocorrência de um conjunto de caracteres se dá com o uso do parâmetro [q] no endereço dado /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 por id do órgão há com o endereço /api/v1/organs.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 /api/v1/organs.json?q=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 /api/v1/organs.json?county=nome_do_município.

As centrais Já! reunem unidades de atendimentos de diversos órgãos e que atende à sociedade com diversos serviços, estas centrais Já! são listadas no sistema com id e nome no endereço /api/v1/centers.json.

Cada uma das centrais já! são descritas com id, name, address, telephone, email, através do endereço /api/v1/centers.json . Para ter as informações de cada uma das centrais já! individualmente usa o endereço /api/v1/center/"id_da_central".json.