Authentication

Three authentication methods are available. API Key is recommended for most integrations.

API Key (Recommended)

Include your API key in the X-Api-Key header with every request.

Getting Your API Key

1. Log in to your Qlara account
2. Navigate to Settings → API Keys
3. Generate a new key or copy your existing key
4. Store it securely (never commit to version control)

Using API Key

cURL

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
  -H "X-Api-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+393901234567",
    "message": "Hello from Qlara!"
  }'

Python

import requests

headers = {
    "X-Api-Key": "your_api_key_here",
    "Content-Type": "application/json"
}

response = requests.post(
    "https://lora-api.agiletelecom.com/api/message-server/sms/send",
    json={"phoneNumber": "+393901234567", "message": "Hello from Qlara!"},
    headers=headers
)

print(response.json())

Node.js

const axios = require('axios');

const config = {
  headers: {
    'X-Api-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const data = {
  phoneNumber: '+393901234567',
  message: 'Hello from Qlara!'
};

axios.post(
  'https://lora-api.agiletelecom.com/api/message-server/sms/send',
  data,
  config
).then(response => console.log(response.data))
 .catch(error => console.error(error));

Basic Authentication

If API keys aren't suitable for your use case, use Base64-encoded credentials.

Generating Basic Auth Credentials

On macOS/Linux:

echo -n "username:password" | base64

On Windows (PowerShell):

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("username:password"))

Using Basic Auth

cURL

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
  -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+393901234567",
    "message": "Hello from Qlara!"
  }'

Python

import requests
from requests.auth import HTTPBasicAuth

response = requests.post(
    "https://lora-api.agiletelecom.com/api/message-server/sms/send",
    json={"phoneNumber": "+393901234567", "message": "Hello from Qlara!"},
    auth=HTTPBasicAuth('username', 'password')
)

print(response.json())

Node.js

const axios = require('axios');

const auth = {
  username: 'username',
  password: 'password'
};

const data = {
  phoneNumber: '+393901234567',
  message: 'Hello from Qlara!'
};

axios.post(
  'https://lora-api.agiletelecom.com/api/message-server/sms/send',
  data,
  { auth }
).then(response => console.log(response.data))
 .catch(error => console.error(error));

IP Whitelisting

Add an extra layer of security by restricting API access to specific IP addresses. This is optional but recommended for production.

Configuring IP Whitelist

1. Go to Settings → Security
2. Enable IP Whitelist
3. Add your server's IP address(es)
4. Save

Any request from a non-whitelisted IP returns 403 Forbidden.

Error Codes

Code	Meaning	Action
401	Invalid credentials	Check API key or Basic Auth credentials
403	Unauthorized IP	Verify your IP is whitelisted (if enabled)

Security Best Practices

1. Never expose API keys in client-side code — Use them only on your backend server
2. Store keys in environment variables — Don't hardcode them
3. Regenerate if compromised — Go to Settings → API Keys and generate a new one
4. Use HTTPS only — All requests must be over HTTPS
5. Rotate credentials periodically — Regenerate keys every 90 days in high-security environments
6. Log access — Monitor your API key usage in the dashboard

Example: Environment Variables

Python:

import os
api_key = os.getenv('QLARA_API_KEY')

Node.js:

const apiKey = process.env.QLARA_API_KEY;

Bash:

curl -X POST https://lora-api.agiletelecom.com/api/message-server/sms/send \
  -H "X-Api-Key: $QLARA_API_KEY" \
  -d '...'

Need help with authentication? Contact support at support@agiletelecom.com.