Começando

Uma API pública destinada a oferecer um conjunto de informações relacionadas à cidade de Aracaju-SE. Acesse dados sobre a capital sergipana de forma simples e eficiente.

O ApiAju é um projeto inspirado na BrasilAPI, criado para oferecer ferramentas e serviços digitalizados voltados à realidade da cidade de Aracaju (SE).

Sua origem está em necessidades reais do dia a dia profissional, especialmente a ausência de soluções que considerassem feriados municipais e regionais em cálculos de datas e automações.

O projeto tem como missão evoluir de forma colaborativa e aberta, reunindo a comunidade local de desenvolvedores para construir serviços modernos, acessíveis e de alta disponibilidade, fortalecendo o ecossistema tecnológico aracajuano.

Começo rápido

Faça requisições através do endpoint base:

https://api.aju.br/api/v1

Com o seu navegador ou cliente HTTP, comece fazendo uma requisição GET para a rota /health para verificar a disponibilidade do serviço:

curl https://api.aju.br/api/v1/health

Você deve ter uma resposta com status 200, indicando que a API está funcionando normalmente com a seguinte mensagem:

{
  "message": "System running"
}

Agora, acesse a guia de documentação para conhecer todas as rotas disponíveis.

Padrão de respostas

Todas as rotas consomem e retornam JSON. Como forma de padronização, todas as respostas com conteúdo terão o seguinte formato:

Message: algumas requisições podem incluir uma mensagem informando sobre o retorno;
Data: a informação solicitada;
Error: um possível erro ocorrido na execução da requisição.

{
  "message": "Mensagem informativa sobre a resposta",
  "data": ...,
  "error": "Descrição do erro"
}

Termos de uso

O ApiAju é uma API pública e gratuita, criada para ser utilizada por qualquer pessoa ou aplicação que deseje integrar informações regionais de Aracaju. Pedimos apenas que o uso seja feito com bom senso e respeito aos recursos disponíveis, evitando práticas abusivas ou que prejudiquem o funcionamento do serviço para os demais usuários.

Contribuindo

Fique à vontade para contribuir com o projeto com aprimoramentos ou novas funcionalidades através do repositório no GitHub:

https://github.com/wolney-fo/apiaju

Contato

Vamos conversar?

E-mail