Overview
SPRL provides a secure REST API that allows developers to integrate URL shortening,
QR Code generation, messaging services, email verification, analytics, and other platform
features directly into their own applications.
Whether you're building a website, mobile app, CRM, ERP, e-commerce platform, or automation workflow,
the SPRL APIs make it easy to interact with the platform programmatically over HTTPS.
What You Can Build
Depending on your subscription and enabled services, you can integrate:
| API | Description |
| Short Link API | Create, update and manage short URLs programmatically. |
| QR Code API | Generate QR Codes for links and campaigns. |
| SMS API | Send transactional and promotional SMS messages. |
| Email API | Send email campaigns and transactional emails. |
| Email Verification API | Validate email addresses before sending campaigns. |
| WhatsApp API | Integrate WhatsApp Business messaging (where available). |
Getting Started
Before making your first API request, complete the following steps.
| Step | Action |
| 1 | Create or sign in to your SPRL account. |
| 2 | Navigate to Dashboard → API & Services → HTTP REST API Keys. |
| 3 | Generate a Live API Key or Test API Key. |
| 4 | Save your Client ID and Client Key securely. |
| 5 | Use the credentials to authenticate your API requests. |
Live Keys vs Test Keys
| Live API Keys | Test API Keys |
| Used in production applications. | Used only for development and testing. |
| Can perform live operations. | Uses sandbox endpoints. |
| Consumes actual account resources where applicable. | Does not perform live operations. |
| Suitable for production deployments. | Recommended during application development. |
Authentication
All protected API requests require authentication using yourClient ID and Client Key.
These credentials identify your application and authorise access to your account.
All requests must be sent over HTTPS.
API Key Management
The API Key Manager allows you to create and manage separate credentials for different applications or websites.
When generating a key, you'll be asked to provide the request domain for organisational purposes.
Each generated key includes:
- Client ID
- Client Key
- Creation date
- Current status
- Rate limit information
For security reasons, the Client Key is displayed only once when it is generated.
Store it securely before leaving the page.
Security
SPRL follows modern API security practices to help protect customer applications and data.
- HTTPS encrypted communication
- Authenticated API requests
- Rate limiting to reduce abuse
- Input validation
- Security monitoring and logging
- Secure cloud infrastructure
Best Practices
- Never expose API keys in client-side JavaScript.
- Store credentials securely on your server.
- Create separate API keys for different applications.
- Rotate API credentials periodically.
- Always use HTTPS.
- Monitor API usage regularly.
Troubleshooting
| Problem | Possible Solution |
| Authentication failed | Verify your Client ID and Client Key. |
| Permission denied | Ensure the API feature is enabled for your account. |
| Rate limit exceeded | Reduce request frequency and retry later. |
| Invalid request | Verify the endpoint, request headers and payload. |
Frequently Asked Questions
Do I need an API key?
Yes. Most API endpoints require authentication using your Client ID and Client Key.
Can I create multiple API keys?
Yes. You can generate multiple API keys for different applications or environments.
Should I use Test Keys first?
Yes. Test Keys are recommended during development before moving to Live Keys for production.
Can I delete an API key?
Yes. Unused or compromised API keys should be removed immediately.
Learn More
Continue with the next guides to learn how to generate API keys, authenticate requests, understand rate limits, use individual APIs, and integrate SPRL into your applications.
Tip
Although you're asked to enter a request domain when creating an API key, treat it as an identifier for your application. Always keep your Client Key private and never embed it directly in publicly accessible websites or mobile applications.