Skip to main content

Sign Up and Generate Your API Key

To get started with Kairos Afrika APIs, you’ll need to sign up and generate your API credentials:
  1. Sign up for an account at the SMS Dashboard
  2. Generate your API credentials from your dashboard
  3. Choose the right authentication method based on the API you’re using

Authentication

Different APIs use different authentication methods:

SMS API Authentication

SMS API uses API key and secret headers:
  • x-api-key: Your API key
  • x-api-secret: Your API secret

Payment API Authentication

Payment API uses Basic authentication with base64 encoded credentials:
  • Authorization: Basic <base64(username:password)>
  • Credentials are manually generated and shared with you
curl -X POST "https://api.kairosafrika.com/v1/external/sms/quick" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "254700000000",
    "from": "Kairos",
    "message": "Hello from Kairos Afrika!",
    "type": "Quick",
    "isGlobal": false
  }'

Environment Setup

Always use the staging environment for testing before going live with production.

Staging Environment

  • Base URL: https://api.staging.kairosafrika.com/v1
  • Purpose: Testing and development
  • Rate Limits: More lenient for testing

Production Environment

  • Base URL: https://api.kairosafrika.com/v1
  • Purpose: Live applications
  • Rate Limits: Standard production limits

Quick Examples

Send an SMS

curl -X POST "https://api.staging.kairosafrika.com/v1/external/sms/quick" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "254700000000",
    "from": "YourBrand",
    "message": "Welcome to our service!",
    "type": "Quick",
    "isGlobal": false
  }'

Initiate a Payment

curl -X POST "https://api.staging.kairosafrika.cloud/paygw/v1/payment" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1,
    "referenceNo": "889909909229",
    "payee": "Kairos",
    "narration": "PIZZAMAN/CHICKMAN",
    "msisdn": "233559400612",
    "callbackId": "6607c05155dfd4919c18c44",
    "payer": "testOne"
  }'

Next Steps