Please Wait...
Authenticate your requests using secure API credentials.
Authentication ensures that only authorised applications can access the SPRL REST APIs. Every protected API request must include valid credentials issued through the SPRL API Key Manager.
Each API Key consists of a Client ID and a Client Key. These credentials identify your application and verify that requests originate from an authorised source.
Generate your API credentials from:
Dashboard → API & Services → HTTP REST API Keys
| Credential | Description |
|---|---|
| Client ID | The public identifier assigned to your application. |
| Client Key | The secret credential used to authenticate API requests. |
Both values are generated together when you create an API Key.
| Step | Description |
|---|---|
| 1 | Create a Live or Test API Key. |
| 2 | Securely store the Client ID and Client Key. |
| 3 | Include the required authentication headers with every protected API request. |
| 4 | The API validates your credentials before processing the request. |
| 5 | If authentication succeeds, the requested API operation is performed. |
Protected API endpoints require your API credentials to be sent in the request headers.
| Header | Purpose |
|---|---|
| Client ID | Identifies your application. |
| Client Key | Authenticates the request. |
Refer to the API endpoint documentation for the exact header names and request format required by each service.
| Live Keys | Test Keys |
|---|---|
| Authenticate requests to production APIs. | Authenticate requests to sandbox APIs. |
| Used by live applications. | Used during development and testing. |
| Recommended after testing is complete. | Recommended while building and validating integrations. |
| Issue | Possible Cause |
|---|---|
| Authentication Failed | Invalid Client ID or Client Key. |
| Access Denied | The API credentials are not authorised for the requested operation. |
| Missing Credentials | Required authentication headers were not included. |
| Invalid Request | The request format or authentication information is incorrect. |
Most protected endpoints require valid API credentials before processing requests.
Yes, although creating separate API Keys for different applications is recommended for easier management and improved security.
No. The Client Key is displayed only once when it is generated.
No. Test Keys are recommended while developing and testing your integration.
Our support team is always happy to assist you.
We use cookies to improve your experience, analyse traffic, and personalise content. By clicking “Accept”, you consent to the use of cookies as described in our Cookie Policy .
Accept cookies Read our Cookie Policy
