Oops! Facing network problem. Unable to load this page. Refresh

Please Wait...

Hello Guest

logo

FAQs

Help
Center

Developer API

Generate and Manage API Keys

Create, regenerate and revoke API keys securely.

4 min read 30 Jul 2026 37 Views

Overview

API Keys allow your application to securely communicate with the SPRL REST APIs. Each key consists of a Client ID and a Client Key, which are used to authenticate your API requests.

SPRL supports both Live API Keys for production applications andTest API Keys for development and testing.

Navigation

Navigate to:

Dashboard → API & Services → HTTP REST API Keys

Live Keys vs Test Keys

Live API Keys Test API Keys
Used for production applications. Used for testing and development.
Connects to live API services. Uses sandbox endpoints.
Suitable for real-world integrations. Safe for development without affecting production.
No expiry unless removed. May include an expiry date depending on the environment.

Generate a Live API Key

  1. Open Dashboard → API & Services → HTTP REST API Keys.
  2. Select the Live Keys tab.
  3. Click Generate Live API Key.
  4. Enter the request domain for your application.
  5. Click Allow Domain & Generate.
  6. Copy and securely store the generated Client ID and Client Key.

Generate a Test API Key

  1. Open the Test Keys tab.
  2. Click Generate Test API Key.
  3. Enter the request domain.
  4. Click Allow Domain & Generate.
  5. Save the generated credentials before leaving the page.

API Key Information

Each generated API Key includes the following information:

Information Description
Client ID Public identifier for your application.
Client Key Secret credential used for authentication.
Status Shows the current state of the API key.
Created Date Date and time the key was generated.
Rate Limit Maximum number of API requests allowed within the configured time period.
Expiry Displayed for environments where key expiration applies.

Managing API Keys

You can manage multiple API Keys for different applications, websites, or environments. This helps separate production systems from development and testing.

Available management options include:

  • View API Key details
  • Copy Client ID
  • Copy Client Key when initially generated
  • Review creation date
  • Review current status
  • Delete unused API Keys

Important Security Notes

  • The Client Key is displayed only once after generation.
  • Store the Client Key in a secure password manager or encrypted secret vault.
  • Never commit API credentials to source code repositories.
  • Never expose API Keys in browser JavaScript or mobile applications.
  • Create separate API Keys for different applications whenever possible.

Best Practices

  • Use Test API Keys during development.
  • Move to Live API Keys only when your application is production-ready.
  • Delete API Keys that are no longer required.
  • Review your API Keys periodically.
  • Keep credentials confidential.
  • Use HTTPS for every API request.

Troubleshooting

Issue Resolution
Forgot to save the Client Key Generate a new API Key, as the original Client Key cannot be viewed again.
Authentication failed Verify that the correct Client ID and Client Key are being used.
Requests are being rejected Verify your request headers and API credentials.
Unused API Key Delete the key to improve account security.

Frequently Asked Questions

Can I create multiple API Keys?

Yes. You can generate separate API Keys for different applications, websites, or environments.

Can I recover my Client Key later?

No. The Client Key is displayed only once immediately after it is generated.

Should I use Test Keys first?

Yes. Test Keys are recommended during development before switching to Live Keys.

Can I delete an API Key?

Yes. API Keys that are no longer required should be removed from your account.

Learn More
Continue to the Authentication Guide to learn how to authenticate API requests using your Client ID and Client Key, then explore the individual API endpoints available for your integration.
Tip
When generating an API Key, you will be asked to enter a request domain. This information is currently used to identify your application and organise your API Keys. Keep your Client Key private and store it securely, as it cannot be viewed again after creation.

Related Articles

Getting Started with SPRL APIs
5 min read
Authentication Guide
4 min read
Create Short Links using API
5 min read
QR Code API
5 min read
Server-to-Server Event Tracking API
5 min read
API Rate Limits
3 min read

Need more help?

Our support team is always happy to assist you.

Contact Support
×

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