O projeto GupyLizeIntegration é uma integração entre as plataformas Gupy e LizeEdu. O objetivo deste projeto é fornecer serviços que permitem o gerenciamento de testes, resultados de exames e candidatos. Ele utiliza a API da plataforma LizeEdu para recuperar e registrar informações sobre candidatos e seus resultados de exames, além de permitir a criação de usuários na plataforma.
- Recuperação de Testes: Obtém a lista de testes disponíveis na plataforma LizeEdu, com a capacidade de filtrar por nome.
- Registro de Candidatos: Cria ou encontra um usuário na plataforma LizeEdu e associa a um teste específico.
- Recuperação de Resultados de Testes: Obtém os resultados dos testes de um candidato baseado no seu ID.
O projeto é composto por dois serviços principais: TestServices
e UserServices
.
O serviço TestServices
é responsável por interagir com a API da LizeEdu para recuperar testes e resultados de exames.
- RecuperarTestes(Integer limit, Integer offset): Recupera uma lista de testes filtrados por nome.
- PegarResultadosDoUsuarioID(String idResult): Obtém os resultados de um candidato específico baseado no seu ID.
O serviço UserServices
gerencia a criação e o registro de candidatos na plataforma LizeEdu.
- encontrarOuCriarUsuario(BodyCandidateRegistration bodyCandidateRegistration): Cria ou encontra um usuário e o associa a um teste específico.
- Spring Boot: Framework usado para construir a aplicação.
- OkHttp: Biblioteca utilizada para fazer requisições HTTP para a API LizeEdu.
- JSON: Biblioteca para manipulação de dados JSON.
- JDK 11 ou superior
- Apache Maven ou Gradle
- Token de acesso válido para a API LizeEdu
- Clone o repositório:
git clone https://github.com/seu-usuario/GupyLizeIntegration.git
- Entre no diretório do projeto:
cd GupyLizeIntegration
- Instale as dependências:
mvn install
- Edite o código para adicionar seu token de API LizeEdu no arquivo
UserServicesImpl.java
nas requisições HTTP. - Execute o projeto:
mvn spring-boot:run
O endpoint encontrarOuCriarUsuario
cria ou encontra um usuário na plataforma LizeEdu. Exemplo de requisição:
POST /api/v2/students/
Content-Type: application/json
Authorization: Token SEU TOKEN LIZE AQUI
{
"email": "[email protected]",
"test_id": "12345",
"name": "Nome do Candidato"
}
Resposta de sucesso:
HTTP/1.1 201 Created
Location: https://app.lizeedu.com.br/conta/sso?access_token=seu_token
Contribuições são bem-vindas! Para contribuir com o projeto:
- Faça um fork do repositório.
- Criar uma branch com suas alterações:
git checkout -b minha-alteracao
- Faça commit das suas alterações:
git commit -am 'Minha alteração'
- Envie para o seu repositório:
git push origin minha-alteracao
- Abra um pull request.
Este projeto está licenciado sob a MIT License - veja o arquivo LICENSE
para mais detalhes.