Authentication

​

API Authentication

• ApiKey: Your unique API key
• ClientId: Your client identifier

​

Base URL

https://app.notify.ng/api/v2/

​

Authentication Methods

​

URL Parameters (Recommended for GET requests)

curl -X GET "https://app.notify.ng/api/v2/Balance?ApiKey=YOUR_API_KEY&ClientId=YOUR_CLIENT_ID"

​

Request Body (For POST/PUT requests)

{
  "ApiKey": "YOUR_API_KEY",
  "ClientId": "YOUR_CLIENT_ID",
  "SenderId": "YOUR_SENDER_ID",
  "Message": "Hello World",
  "MobileNumbers": "1234567890"
}

​

Getting Your Credentials

1. Sign up for a Ruach SMS API account
2. Navigate to your dashboard
3. Generate your API key and Client ID
4. Keep your credentials secure and never share them publicly

​

Security Best Practices

• Store credentials in environment variables
• Use HTTPS for all API requests
• Rotate your API keys regularly
• Monitor your API usage for suspicious activity

​

Rate Limits

• Standard accounts: 100 requests per minute
• Premium accounts: 1000 requests per minute

​

Error Responses

{
  "ErrorCode": 001,
  "ErrorDescription": "Account details cannot be blank"
}

• 001: Account details cannot be blank
• 007: Invalid username or password
• 008: Account inactive
• 010: Unauthorized API access