API credentials
Learn how to generate the API credentials required for authentication.
Overview
This page explains how to generate the credentials required for Walmart Connect Display API authentication.
Before you can authenticate API requests, you must:
- Generate RSA key pairs
- Upload public keys
- Receive environment-specific credentials
For details on authentication headers, request signing, and making authenticated API requests, see Authentication & Headers.
Already using Walmart Connect Sponsored Search APIs?If you already have valid Walmart Connect Sponsored Search API credentials, you can reuse the same credentials to access Display APIs. No additional credential generation is required.
Credential generation process
1. Generate RSA keys
Create public and private RSA key files.
2. Upload public keys
Upload Sandbox and Production public keys through the Partner Onboarding Hub.
3. Credentials generated
Walmart validates the keys and generates environment-specific credentials.
4. Begin authentication
Use the issued credentials to authenticate API requests.
Generate RSA key pairs
Credential generation requires an RSA key pair for each environment.
To complete this process, you will need an OpenSSL installation (for example, Homebrew on macOS).
Generate RSA key pair
openssl genrsa -des3 -out agency_key_pair 2048Export private key
openssl pkcs8 -topk8 -inform PEM -in agency_key_pair -outform PEM -out agency_private_key.pem -nocryptExport public key
openssl rsa -in agency_key_pair -outform PEM -pubout -out agency_public_key.pemUnderstanding the generated files
| File | Purpose |
|---|---|
agency_private_key.pem | Kept by your organization and used to generate authentication signatures |
agency_public_key.pem | Uploaded to Walmart during onboarding |
agency_key_pair | Intermediate key-pair file used during generation |
Uploading public keys
Upload both public keys through the Partner Onboarding Hub:
- Sandbox public key
- Production public key
Separate uploads are required because Sandbox and Production use separate credentials.
What credentials will I receive?
After public keys are uploaded and validated, Walmart generates environment-specific credentials.
| Credential | Purpose |
|---|---|
| Consumer ID | Identifies your partner account |
| Auth Token | Used in the Authorization header |
| Key Version | Identifies the active RSA key version |
These values are used when generating authenticated API requests.
Environment-specific credentials
Sandbox and Production environments use separate:
- RSA key pairs
- Consumer IDs
- Auth Tokens
- Key Versions
Credentials generated for one environment cannot be used in the other.
| Environment | Base URLs | Credentials |
|---|---|---|
| Sandbox | https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/ | Sandbox Consumer ID, Auth Token, and Key Version |
| Production | Provided by Partner team | Production Consumer ID, Auth Token, and Key Version |
What happens next
After your public keys have been uploaded:
- Walmart validates the submitted keys
- Credentials are generated for the environment
- You receive notification when Sandbox credentials are available
- You can begin testing authenticated API requests
Related pages
Updated about 5 hours ago