RSA Keypair (API)

RSA authentication for API Users

You need to generate an RSA keypair per API User, we highly recommend doing this on a personal computer preferably when you're disconnected from the internet. Ensure you do not create them online on an unknown website or copy from a source you do not trust.

The OpenSSL is a go-to choice for this process. The process using OpenSSL is described below in brief:

openssl req -new -newkey rsa:4096 -nodes -keyout mykey.pem
openssl rsa -in mykey.pem -pubout > mykey.pub

You'll have two files mykey.pem and mykey.pub after the execution of the above two shell commands. You'll be sharing the mykey.pub with us when you'll create an API User from the control panel.

Please make sure you store both keys in safe storage. Additionally. the mykey.pem is needed by your client application from where you intend to make requests to our backend. Your client application will create encrypted JWT tokens with these keys and will never transmit these keys with the request. We will store your public key mykey.pem file as an encrypted key and would use it to verify your identity before processing any request.

OpenSSL for Windows

If you do not have OpenSSL installed in your Windows OS, you can download it using the link given below:

https://slproweb.com/download/Win64OpenSSL_Light-3_3_1.msi

If the above commands do not work on the Windows command prompt (cmd.exe), try the following:

"c:\Program Files\OpenSSL-Win64\bin\openssl.exe" req -new -newkey rsa:4096 -nodes -keyout mykey.pem
"c:\Program Files\OpenSSL-Win64\bin\openssl.exe" rsa -in mykey.pem -pubout > mykey.pub