API Development And
Integration Guide
Get Started
Product API
Order API
Customer API
Common Parameters & Headers
Error Handling & Status Codes (Optional)
Postman Collection & Tools (Optional)
Global Headers
Proper headers ensure secure, consistent, and reliable communication with the WUPEX API across all environments.
Required Headers
Every WUPEX API request must include the following HTTP headers:
json
x-api-key: YOUR_API_KEY Accept-Language: en-US Content-Type: application/json // Required for POST/PUT requests
- x-api-key:
- A unique, opaque API key used for authentication. It should always be passed in the header—not in URLs—to prevent accidental exposure (e.g., logs, browser history)
- Accept-Language:
- Tells the API your preferred localization format (“en-US”). Using headers for localization is a standard practice and recommended over URL or payload methods .
- Content-Type:
- Declares that the body of your request is JSON. Always include this for POST or PUT requests to ensure proper parsing.
Why These Headers Matter
- Security
- Headers keep credentials out of URLs, reducing the risk of leaks via logs, browser history, or proxies
- Localization Consistency
- Accept-Language ensures date, time, or currency formats conform to expected locale settings
- Parsing Reliability
- Explicit Content-Type lets WUPEX properly decode and validate your JSON payloads, avoiding ambiguous formats.
Security Best Practices
- Secure Storage: Always store API keys in secure locations (environment variables, secret managers). Never hard-code or expose them to front-end or mobile clients
- Environment Separation: Keep sandbox and production keys distinct to prevent accidental usage across environments.
- Periodic Rotation: Periodically regenerate API keys and revoke unused ones to reduce exposure risk
- Transport Security: Always use HTTPS to encrypt headers and payloads. SSL/TLS already protects headers during transport .
- Avoid Front-End Exposure: Never embed API keys in client-side code or browser-facing environments. Instead, use your server backend to manage authenticated API calls .
Optional Headers (Advanced Integration)
- To support observability and proxy environments, consider:
- User-Agent: Custom client identifier (e.g., WUPEX-SDK/1.0)
- X-Request-ID: Unique ID for tracing across services
- Accept-Encoding: To enable compressed responses (e.g., gzip)
- Cache-Control: Manage cache behavior for GET requests
- CORS-related headers if needed in browser-based integrations
Integration Examples
- cURL Example:
bash
curl -X POST https://service.wupex.com/api/product/merchant/invited/list \
-H "x-api-key: YOUR_API_KEY" \
-H "Accept-Language: en-US" \
-H "Content-Type: application/json" \
-d '{"page":1,"pageSize":20}'
- Node.js Fetch Example:
js
await fetch(`${baseUrl}/api/customer/balance`, {
headers: {
"x-api-key": process.env.WUPEX_API_KEY,
"Accept-Language": "en-US",
"Content-Type": "application/json"
}
});
Let’s Boost Your
Business Efficiency
Say goodbye to delays, fraud, and complex setups—our solution is built for speed and trust.
Get Latest News for Free!
Sign up to get product updates, new partner alerts, and
exclusive API insights
exclusive API insights
No spam. Unsubscribe anytime
Why WUPEX?
Partners
- Apple
- PSN
- Razer Gold
- Xbox
- PUBG
- Steam
- Jawaker
- Roblox
- Fornite
- Minecraft
- Yalla Ludo
- FC Mobile
- Freefire
Industries
- Banks & Fintech
- Retail & eCommerce
- Payment Gateways
- Telecom & Wallets
- Gaming & Esports
- Corporate Gifting
Resources
- Blog
- FAQ
Company
- About Us
- Meet Our Team
- Contact Us
- Partnership
- Terms & Conditions
Downloads
- Catalogue
- Company Profile
- API Documentation
Features
- Seamless Integration
- Secured API
- Real-Time Delivery
- Bulk Digital Gift Cards
- Fraud Prevention
- Global Brand Access
Support
- Get Started
- Customer Support
- Portal Guide
- API Integration Guide
- Help Center
Copyright © 2024 WUPEX | All Rights Reserved.
Why WUPEX?
Partners
- Apple
- PSN
- Razer Gold
- Xbox
- PUBG
- Steam
- Jawaker
- Roblox
- Fornite
- Minecraft
- Yalla Ludo
- FC Mobile
- Freefire
Industries
- Banks & Fintech
- Retail & eCommerce
- Payment Gateways
- Telecom & Wallets
- Gaming & Esports
- Corporate Gifting
Features
- Seamless Integration
- Secured API
- Real-Time Delivery
- Bulk Digital Gift Cards
- Fraud Prevention
- Global Brand Access
Support
- Get Started
- Customer Support
- Portal Guide
- API Integration Guide
- Help Center
Company
- About Us
- Meet Our Team
- Contact Us
- Partnership
- Terms & Conditions
Resources
- Blog
- FAQ
Downloads
- Catalogue
- Company Profile
- API Documentation
Copyright © 2024 WUPEX | All Rights Reserved.