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] Define workflow for API consumers #186

Open
gnuletik opened this issue May 6, 2020 · 0 comments
Open

[API] Define workflow for API consumers #186

gnuletik opened this issue May 6, 2020 · 0 comments
Assignees
Milestone

Comments

@gnuletik
Copy link
Collaborator

gnuletik commented May 6, 2020

As talked in #165 we should define (and implements in the future) the workflow to provide API tokens to the users of the Timeside API.

Here's a first draft adapted from @yomguy's comments

  1. the Developer creates an account and request an access to the API
  2. the Admin or a method validate the access
  3. the Developer receives a token to use in his app
  4. the Developer use the tokens to setup its own client application consuming the API

Before releasing this, we should be able to monitor the following data :

  • Number of API calls
  • API response times by route
  • API and workers load

We should be able to filter this data for each token / app / client in order to prevent abuse of the infrastructure and eventually scale.

We should also add django methods or API calls or UI to let admin remove a client access
We should also think about a ratio system (by API calls ? by worker's processing time ? By number of analyzed seconds in an audio file ?)

Any thoughts ?

@yomguy yomguy added this to the 1.3 milestone Jan 24, 2023
@yomguy yomguy self-assigned this Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants