REST API Overview & Key Generation
Connect your external warehouse, custom storefront, or inventory software to the ePaisay marketplace.
Our REST API is built on OpenAPI 3.0 standards, offering predictable resource URLs, JSON bodies, and standard HTTP error codes.
Core Architecture & Principles
- API Keys & Signatures: HMAC-SHA256 signature authentication guaranteeing payload integrity and sender non-repudiation.
- Sandbox & Production: Full test sandbox environment with mocked payment and courier endpoints for safe development.
- Rate Limiting: Standard tier permits 60 requests/minute; enterprise tier supports up to 1,200 requests/minute.
Operational Process & Execution Flow
Developer Registration
Navigate to Developer Console inside Account Settings and accept Developer Terms.
Key Provisioning
Generate API Key and API Secret token. Secure the secret token immediately—it is displayed only once.
Initial Ping Test
Execute a test GET request to `/api/v1/ping` with Authorization headers to confirm connectivity.
Security Protocol
Never commit API Secrets into public repositories or client-side JavaScript. Always rotate keys every 90 days.