Our APIs are deployed in isolated Sandbox and Production environments. Charter Supplier onboarding onto these environments requires authentication with the Walmart API Proxy/Gateway before initiating an API call. The first step to authenticating your access is generating access keys.

Before you begin:

🚧

If you have already onboarded to Data Feeds APIs, you do not need to generate keys again. Please also make sure your business partners have already connected with a Walmart Data Ventures Account Manager.

Before you begin generating your API access keys, you need to have access to a command line terminal. For Windows systems, ensure that either Git Bash or OpenSSL for Windows has been installed. PuttyGen tool is not recommended as the default format is not PKCS8.

Generating API Keys - Windows-based Systems

Watch the video or continue reading below to generate your keys.

1. Create a desktop folder, titled "RSA Keys" (optional)

2. Right-click the folder and select "Show more options" to open the Git Bash or OpenSSL terminal (optional)

3. From the terminal command line, you will generate an RSA key-pair:

   • Paste the following command into the terminal and hit enter.

     $ winpty openssl genrsa -des3 -out my_rsa_key_pair 2048 

   • Using -des3 ensures that the pem file generated in the above step will be passphrase protected. You will be prompted for the passphrase. The passphrase will be located directly above the prompt in the terminal. In the example below, 65537 is the passphrase:
     Example:

     e is 65537 (0x010001)
     Enter pass phrase for my_rsa_key_pair:
     

     Note: Please note this passphrase in a safe location. You will use it again.

   • Type the passphrase into the terminal where prompted (note that while entering the passphrase, it will not look like you are actually typing) and hit enter.

   • You may be prompted to enter the passphrase twice.

4. Next, you will export the private key in the private_key.pem file:

   • Paste the following command into the terminal and hit enter.

     $ winpty openssl pkcs8 -topk8 -inform PEM -in my_rsa_key_pair -outform PEM -out private_key.pem -nocrypt
     

   • Type the same passphrase into the terminal where prompted (note that while entering the passphrase, it will not look like you are actually typing) and hit enter.

5. Finally, you will export the public key in the public_key.pem file:

   • Paste the following command into the terminal and hit enter.

     $ winpty openssl rsa -in my_rsa_key_pair -outform PEM -pubout -out public_key.pem 

   • Type the same passphrase into the terminal where prompted (note that while entering the passphrase, it will not look like you are actually typing) and hit enter.

What Happens Next

You should now have three files in the folder you created (or your chosen location): my_rsa_key_pair, public_key.pem, and private_key.pem.

If you are requesting access to multiple environments, remember to repeat the above steps for each environment you are requesting. It is helpful to sufficiently label your RSA folders for easier reference when generating Authentication Signatures.

🚧

Keep your private key(s) safe.

This will be used to generate the Authentication Signature before making any API call. Your private key should be protected just as you would a password. Walmart is not responsible for your private key. Please keep your private key in a secure location.

Now that you have your keys, you will be able to move on to Step 2.

©️Walmart | All Rights Reserved