Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Api-Validação do CPF do proprietário #71

Merged
merged 6 commits into from
Jul 9, 2024
Merged

Conversation

cellaaleo
Copy link
Contributor

@cellaaleo cellaaleo commented Jul 8, 2024

Título

Como sistema externo, é possível validar se o CPF informado é de um proprietário/morador de um imóvel, para que se saiba se um determinado CPF é de um proprietário/morador existente na aplicação.

Objetivo

Permitir que a aplicação PagueAluguel consiga validar, a partir do CPF, se determinado usuário é morador ou proprietário de uma unidade no CondoMinions

Endpoint

GET /api/v1/check_registration_number?registration_number={CPF}

Retorna o perfil do usuário do CondoMinions e, caso exista, o id de sua unidade.

Exemplos de resposta:

{
  "profile": "owner",
  "unit_id": "1"
}
{
  "profile": "tenant",
  "unit_id": "10"
}
{
  "profile": "inexistent",
  "unit_id": "nil"
}

OBS: Caso o CPF seja inválido, será retornado o erro 412 (precondition failed) e o json com o campo 'error'.

{
  "error": "invalid registration number"
}
``

Adicionalmente, atualiza o readme com a documentação necessária para consumir o novo endpoint da API.

Resolve a issue #53 

@cellaaleo cellaaleo added documentation Improvements or additions to documentation enhancement New feature or request pague aluguel Requires communication with PagueAluguel application labels Jul 8, 2024
@Vinigperuzzi Vinigperuzzi marked this pull request as ready for review July 8, 2024 22:24
app/controllers/api/v1/residents_controller.rb Outdated Show resolved Hide resolved
Copy link
Contributor

@ruliancruz ruliancruz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deixei alguns comentários, mas foram apenas de detalhes e parte foram apenas perguntas/sugestões. Fora eles e o que foi mencionado no comentário do @luckslima, não vejo problema algum, por isso já deixei aprovado.

README.md Outdated Show resolved Hide resolved
spec/requests/apis/resident_spec.rb Show resolved Hide resolved
spec/requests/apis/resident_spec.rb Outdated Show resolved Hide resolved
cellaaleo and others added 2 commits July 9, 2024 15:57
… app, e atualiza o readme.

Co-authored-by: Vinícius Peruzzi <[email protected]>
@ruliancruz ruliancruz linked an issue Jul 9, 2024 that may be closed by this pull request
@Vinigperuzzi Vinigperuzzi merged commit cd6d0f2 into main Jul 9, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request pague aluguel Requires communication with PagueAluguel application
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API - Validação do CPF do proprietário
4 participants