Esta API foi criada para alimentar o sistema de frontend do SETE, foi criada com PHP e utiliza o framework Laminas.
- Sobre o SETE
- Pré-Requisitos
- Como executar a API
- Como configurar o banco de dados
- Como fazer as requisições
- Tecnologias
- Contribuidores
O Sistema Eletrônico de Gestão do Transporte Escolar (SETE) é um software de e-governança desenvolvido pelo CECATE UFG voltado a auxiliar na gestão do transporte escolar dos municípios brasileiros considerando suas singularidades. O sistema foi projeto com intuito de não depender de nenhum software proprietário, desta forma é possível utilizá-lo sem ter de licenciar programas dependentes.
Para utilizar a API do SETE é preciso instalar em sua máquina: Git, PHP v7.4, Composer. Agora só precisa fazer algumas configurações.
O primeiro passo é clonar o repositório.
Depois precisa liberar algumas extenções do PHP, para isso acesse o php.ini como administrador e descomente:
extension=openssl
extension=intl
extension=fileinfo
extension=gd2Após isso, através do terminal, acesse a pasta do projeto e coloque o seguinte comando para instalar as depedências.
$ composer installPor fim, execute o servidor com o seguinte comando:
$ php -S 0.0.0.0:8080 -t public/ public/index.php
# O servidor iniciará na porta:8080.Para configurar o banco de dados é preciso ter instalado o POSTGRESQL.
Para fazer as requisições localmente é preciso instalar o POSTMAN, depois precisamos configurar a collection. Passo a passo:
- Em authorization, selecione o "Type" como "API Key".
- Preencha "Key" com "Authorization"
- Em "Value" coloque sua {{API_KEY}}.
- Por fim, selecione "Header" em "add to".
Já na aba de "Variables" adicionaremos cinco em "variable":
- API_KEY: É preenchido com sua api_key em "inicial value" e "current value".
- USERNAME: É preenchido com seu e-mail em "inicial value" e "current value".
- PASSWORD: É preenchido com sua senha criptografada em "inicial value" e "current value".
- HTTP_URL: É preenchido com "https://localhost:8080" em "inicial value" e "current value".
- CIDADE: É preenchido com o código da sua cidade em "inicial value" e "current value".
Por fim, é preciso acessar a documentação do SETE - API e seguir os formatos de requisições desejadas.
Ferramentas utilizadas na construção do projeto:
Umarley Ricardo |
Pedro Henrique |
Natália Souza |
John Heberty |