Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Django FastAPI integration #355

Closed
12 of 13 tasks
cduhn17 opened this issue Dec 12, 2022 · 1 comment · May be fixed by #384
Closed
12 of 13 tasks

Django FastAPI integration #355

cduhn17 opened this issue Dec 12, 2022 · 1 comment · May be fixed by #384
Assignees
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use upstream update This issue or pull request pulls in upstream updates

Comments

@cduhn17
Copy link
Collaborator

cduhn17 commented Dec 12, 2022

Implement user login, complete with self server password administration to establish API key for REST endpoint authentication.

Motivation and context
The REST endpoints are needed to share PE Reports data to 3rd party as well as inter agency partners. The api key and associated login management are needed to safely control endpoint usage.

Implementation notes
The user that has a need to consume PE Reports data, would register with the REST system. The user would create a username and password that would create an API key that would then be used to make API calls and return data to the user programmatically. The REST endpoint will work in conjunction with our current Flask application #115.
Related to #355
-Remaining tasks

  • Create api token.(This task is similar to creating the reset token)
  • API can be accessed alongside of pe-reports generator
  • Create dependent functions to pull API user functions.
  • Create REST api endpoint and apply authorization technique utilizing api token
  • Create a user page to display the user api key
  • Check access token for expiration
  • Create endpoint to self admin new api keys

Acceptance criteria
How do we know when this work is done?

  • All testing checks will pass.
  • Code in P&E repo will be treated as authoritative
  • Team source code collaboration will be done through P&E repo rather than via Teams
  • User will be able to create a new account.
  • Self administer password resets.
  • Receive API key to interact with PE Reports data.
@cduhn17 cduhn17 added improvement This issue or pull request will add or improve functionality, maintainability, or ease of use upstream update This issue or pull request pulls in upstream updates labels Dec 12, 2022
@cduhn17 cduhn17 self-assigned this Dec 12, 2022
@cduhn17 cduhn17 mentioned this issue Dec 12, 2022
7 tasks
@cduhn17 cduhn17 linked a pull request Jan 6, 2023 that will close this issue
12 tasks
@cduhn17
Copy link
Collaborator Author

cduhn17 commented Jan 6, 2023

This issue is considered done and has a PR #384

@cduhn17 cduhn17 closed this as completed Jan 6, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use upstream update This issue or pull request pulls in upstream updates
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant