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

README / Github frontpage - getting an API key is harder than you make it seem #82

Open
LinuxOnTheDesktop opened this issue Aug 25, 2021 · 3 comments

Comments

@LinuxOnTheDesktop
Copy link

LinuxOnTheDesktop commented Aug 25, 2021

Unless I make some mistake, the 'How to get API key' section omits the prerequisite of obtaining a Virus Total account.

EDIT: Having some explanation, in-app and/or in the README, of the 'direct file upload' would be good to. I imagine that what is at issue is whether or not confirmation is required to upload. If that is the case, it would be better to use this text: 'Require confirmation for upload'.

@SamuelTulach
Copy link
Owner

First of all, it is clearly stated that you should create a profile:

image

Secondly, by nature you will always need an account to be linked with API key. What would be the point of the API key in a first place if you could just generate one without an account? Might as well send random string instead of API key...

@LinuxOnTheDesktop
Copy link
Author

On your first point: yes and no. Yes, the reader is told to create a profile. Yet, 'create profile' is sandwiched between a link and a giff, where the latter shows only the next part of the process. So, the reader who is not especially diligent would be served by, say, (i) italicising 'create a profile' and (ii) the changing of the text at the end of the sentence to: 'and (as shown in the animated image below) copy your key'.

Your second point presupposes knowledge that the user might be lacking (or at least an inference the reader) has not made.

@e-t-l
Copy link

e-t-l commented Jan 26, 2022

Your second point presupposes knowledge that the user might be lacking (or at least an inference the reader) has not made.

Well, that's how API keys work.

Also, for what it's worth, you can use your Github account to sign onto VirusTotal. So "creating a profile" takes three clicks and about ten seconds.

Lastly, if you think you can improve the wording of the instructions on this page, you're free to open a PR with your suggested edits to the readme file.

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

No branches or pull requests

3 participants