novu icon indicating copy to clipboard operation
novu copied to clipboard

Clarify API Keys vs Application Identifier

Open amirhmoradi opened this issue 2 years ago • 3 comments

What?

In 'Settings' menu, 'Api Keys' tab, I am not expecting to have my 'Application identifier', it is confusing.

On the other hand, to enable HMAC for subscriberId encryption, the documentation does not make it clear enough and I got confused between API key and Application identifier to use for hashing.

Why?

To make it easier for developers to understand the mechanism and have a better integration experience.

How?

Either the tab name may be changed from 'Api Keys' to something more generic, or the application identifier can be moved somewhere else like below the "Development / Production" switch thingy.

Also the documentation shall be updated to make it clear that the API key is used to create the HMAC and not the APP ID.

Other information

None

amirhmoradi avatar Jul 13 '22 19:07 amirhmoradi

@scopsy Is this issue available to work on?

Nike682631 avatar Aug 11 '22 18:08 Nike682631

Sure @Nike682631 do you have some ideas on how this can be solved and be more clear? Maybe see how other applications treat those situations?

scopsy avatar Aug 12 '22 09:08 scopsy

I want to take this up but not sure how to solve it. Maybe I can try it out after my exams(20th Jan)

Susmita-Dey avatar Jan 07 '23 10:01 Susmita-Dey

Hi can i pick this up?

Vrishabhsk avatar May 27 '23 10:05 Vrishabhsk

@nknyshov what do you think about this suggestion and the current state of our Settings menu and the API keys tab? Do you think there is room to improve?

p-fernandez avatar Jun 15 '23 13:06 p-fernandez

I would like to work on this. Can you assign it to me?

mpatwa98 avatar Oct 06 '23 11:10 mpatwa98

@mpatwa98 you are now assigned :)

davidsoderberg avatar Oct 06 '23 12:10 davidsoderberg

Can you help me with where to start and how to implement it? @davidsoderberg

mpatwa98 avatar Oct 08 '23 10:10 mpatwa98

Please ask in discord and we will help you out :)

davidsoderberg avatar Oct 09 '23 05:10 davidsoderberg

hey @amirhmoradi or @davidsoderberg can i do something "Use this API key to interact with the Novu API and create the HMAC encryption" or Moved the Application identifier below development/production>..

Reference: Screenshot 2023-10-17 230920

Naushad-ansarintiw avatar Oct 17 '23 17:10 Naushad-ansarintiw