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

Add OAuth2 or somehow simplify login/getting and differentiating API keys #124

Open
rugk opened this issue Mar 15, 2024 · 3 comments
Open
Labels
enhancement New feature or request

Comments

@rugk
Copy link

rugk commented Mar 15, 2024

See Traewelldroid/traewelldroid#334 for backstory.

Ideas

  • Best would be to have a real OAuth2 workflow or something similar.
  • Another idea would be to have a page for the generation of a specific token, apps can link to. Also, apps should specify, which token they want and not let the user search for the correct one. (Like https://travelynx.de/account/api/travel for the travel API.)

Also:

  • Tokens seem to have a fixed (or maybe not so fixed) prefix? Could this be documented? Note here I speculated about the reason.
  • Also, if we are using fixed prefixes, could not we also use an additional prefix or so for differentiating between the different prefixes/use cases?
  • Also, like GitHub tokens, if you really want to allow secret scanning with them, you may also make them more humanreadable, like TRAVLYX-travel-tokenhere.
@deingithub
Copy link
Contributor

As an API consumer, I much prefer not dealing with the conceptual and implementation overhead of OAuth. But I agree that the UI for creating and revoking tokens could definitely use some polishing and perhaps less technical explanations. For my project interfacing with traxelynx I've written some user guidance with a screenshot that looks like this, maybe something in that direction would be helpful for träwelldroid too in the meantime?
image-165

@rugk
Copy link
Author

rugk commented Mar 15, 2024

Yeah, Traewelldroid has OAuth already implemented (for Traewelling), but yeah of course UI improvements would be the first step IMHO.

@derf derf added the enhancement New feature or request label Apr 15, 2024
@derf
Copy link
Owner

derf commented Apr 15, 2024

I'm not 100% happy with the current API myself, so I might look into improving it at some point. That may or may not include OAuth2 support in addition to the current token system. We'll see :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants