Generate Partner API keys

Prerequisites

To generate keys for the Partner API, you must have the following:

• A Qredo account
• API access enabled

Overview

There are two main steps you need to take:

1. Generate a Qredo API key for authentication.
2. Generate RSA keys to authorize and sign API requests.

Step 1: Generate a Qredo API key

The Qredo API keys are Base64-encoded and are used for API user access. There are two types of Qredo authentication API keys:

• Production keys: use these for live action with the Partner API.
• Sandbox keys: use these to test your integration with the Partner API.

To generate a Qredo API key, do the following:

1. Sign into the Qredo Web App.

2. In the top right corner, click on your name, select the Account type you need, and click Settings.

3. From the tabs, select Partner API to display the following screen:

1. Click Generate API Key. You will see the following:

1. Click Copy to clipboard. This copies the Base64-encoded authentication key for the environment to your clipboard.

2. Paste the key into a text file and save it as apikey (no file extension). You will use this file with the Partner API Signing Client.

Step 2: Generate RSA keys

The API requires an RSA key pair for authorizing and signing requests:

• The private RSA API key signs the requests.
• The Qredo server verifies the signature against the public RSA API key.

The following example uses the terminal CLI (Command Line Interface) for generating the RSA key pair, but you can use any preferred tool to perform this task. The Qredo Partner API works with 2048-bit RSA keys.

2.1. Generate a key pair

Generate a 2048-bit RSA key pair and store the private key in a file named private.pem:

openssl genrsa -out private.pem 2048
 Copy

You should see the following message:

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

openssl genrsa -traditional -out private.pem 2048
 Copy

2.2. Extract the public key

Extract the public key from the key pair and store it in a file named public.pem:

openssl rsa -in private.pem -outform PEM -pubout -out public.pem
 Copy

You should see the following message:

writing RSA key
 Copy

2.3. Upload the public key

You need to associate the RSA key pair to your Qredo account by adding your public RSA keys using the Qredo Web App.

To complete this procedure, return to the Partner API page in the Web App:

1. Sign in to the Qredo Web App.

2. In the top right corner, click on your name and open Settings for the required account.

3. Select Upload Public Key to open a dialog box.

4. Locate the public.pem RSA key file you created earlier and open it using a text editor or list in your terminal.

   cat public.pem
    Copy

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

   -----BEGIN PUBLIC KEY-----
   ExAMplENBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyk14HdJt9Tc/Pws3aFLL
   9PAt4x+OnuLGmLQHWAM7vucuOR3+rlrpkHPC+9T17sxvVq/BFx2Rkd9pSqD130/W
   S0MVqCXOwYzB3YdTtiHNNBS4I3fUViYfz7hF3YGUtimMg1RQIerr15bIMUVdAdFY
   ze7MHYwgYb5YRMUa9d6k4Ehq9lPmwvHwEFVSTCAl9XvGU5+qUK+kLYim2gcdhgXQ
   Oe8M1bGmWvEOgxg5brUPHzquPMlShiRMO6mibCg6pSb7HsFAucoB8y3soDtHe5Zr
   qJHgsHTuNhX2PPdOgYVuX8KiTD28zY2VCkDux9DabJ7J5RdxS1nNszea2o9qWhf1
   +QIDAQAB
   -----END PUBLIC KEY-----
    Copy

6. Click Upload.

7. Success: a green LIVE indicator appears.

   More recent versions of the Web App support just one key type. Use the key in Production and/or the Sandbox environments according to your need.

   

Next, understand how to authenticate and authorize API calls.