Version: current

02 Generate Keys

Congratulations and welcome to the Qredo Partner Program.

This step assumes that you have completed STEP ONE: Apply to be a Partner and have been accepted to the Partner Program.

This section explains

  1. Key Types
  2. STEP 1 - Generate RSA API Key Pair
  3. STEP 2 - Generate Authentication Keys
  4. STEP 3 - Upload Public Keys
warning

Keep your keys safe

  • DO NOT share them with any other party.
  • DO NOT embed keys into code.

Key Types#

Authorization API Keys and Authentication API Keys are used in every transaction.

RSA API Keys - Request Authorization#

RSA API Keys are used to authorize and sign requests to the API.

A pair of RSA Keys are generated and must be used to sign requests.

  • The public RSA API key is used to verify the signature by the Qredo server.
  • The private RSA API key is used for signing requests.

The signature is required to provide additional security to API requests.

Authentication Keys - User Authentication#

The Authentication API Keys are Base64 encoded keys used to verify user access.

There are 2 types of Authentication API Keys: SANDBOX Keys for enabling testing and PRODUCTION Keys for generating live requests.

Sandbox Keys#

Use Sandbox Keys to test your technical integration with Qredo's software and to simulate API requests. It is advisable to test with Sandbox Keys prior to going live.

info

Sandbox and Production Keys are used in the same environment.

Production Keys#

After completion and verification of integration testing, you can use Production API keys to perform live requests.

01 Generate RSA API Key Pair#

The following is an example method for generating keys in the CLI.

  1. To generate a 2048 bit RSA Key, run the following command in your CLI
openssl genrsa -out private.pem 2048

You should see the following response:

Generating RSA private key, 2048 bit long modulus...

A Private Key is generated and stored as a private.pem file.

  1. To extract the public key from the key pair run the following command:
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

You should see the following response:

writing RSA key

A Public Key is generated and stored as a public.pem file.

02 Generate Authentication keys#

  1. In the Qredo Web App

  2. In the top right corner, click on your name and open User Settings > Account Settings

  3. In the list of settings, select Partner API to view the following screen:

partnerapi

  1. On the 'Partner API' screen, under Sandbox, select Generate API Key. Your SANDBOX Key ID and SANDBOX API Key are shown.

    An 'Alert Box' appears.

sandboxkey

  1. Click Copy to clipboard. This copies the Base64 encoded Authentication Key for the SANDBOX environment to your clipboard.

  2. Paste this key into a text file called apikey. Ensure that it is easily accessible. You need it to authenticate requests.

note

If you forget to copy or lose the SANDBOX key, you can regenerate a new one by selecting Regenerate.

  1. Repeat steps 4. to 6. for Production authentication API keys.

03 Upload Public Keys#

You need to upload the same RSA public key to one or both the Sandbox and Production boxes.

  1. To perform Sandbox requests, select Upload Public Key to open a dialog box.

sbboxdialog

  1. Locate the public.pem RSA key file you created earlier and open it using a text editor.

  2. Copy the entire contents and paste into the dialog box.

examplekey

  1. Click Upload.

  2. Successful completeion is indicated by 'Environment Live'.

sandboxuploadconfirmation

  1. To perform Production requests, repeat the previous steps for the Production box.
warning
  • Keep your keys safe and DO NOT share them with any other party.
  • To ensure security. DO NOT embed keys into code.

Next Steps#

Proceed to STEP 3 - Generate a Signature