API Keys
You’ll need to use two keys for authentication:- Public API Key: Identifies your account
- Private API Key: Verifies your identity (keep this secure)
Authentication Headers
Include the following headers in all your API requests:Header | Description |
---|---|
X-API-Public-Key | Your public API key |
X-API-Private-Key | Your private API key |
Security Best Practices
- Never share your private key: Keep your private API key confidential
- Use environment variables: Store keys in environment variables rather than hardcoding them
- Rotate keys periodically: Change your API keys regularly as a security best practice
Basic Authentication Example
This example shows how to authenticate and retrieve customer information using the/customer/retrieve
endpoint:
Troubleshooting Authentication Issues
If you encounter authentication errors, check the following:Error | Possible Cause | Solution |
---|---|---|
401 Unauthorized | Invalid API keys | Verify your API keys are correct and properly formatted |
No response | Network issues | Check your network connection and firewall settings |
API Key Management
You can manage your API keys through the Ping Proxies dashboard:- Log in to your account
- Navigate to the API Keys section
- View your current keys or generate new ones