openlyne/Openlyne-Chat-API
Domain:
digital infrastructureRecord type:
software
Creator:
ope
Host:
A REST-based WhatsApp messaging platform designed for developers across Africa. Send and receive WhatsApp messages programmatically with simple HTTP requests.
# Openlyne API - Alpha Release
> A REST-based WhatsApp messaging platform designed for developers across Africa. Send and receive WhatsApp messages programmatically with simple HTTP requests.
## 🚀 Quick Start
1. Register for your account
2. Verify your email
3. Connect your WhatsApp
4. Make your first API call
## 📋 Table of Contents
- Registration
- Email Verification
- API Credentials
- WhatsApp Connection
- Sending Messages
- Receiving Messages
- API Endpoints
- Alpha Limitations
- Troubleshooting
- Support
## 🔐 Registration
1. **Register your account**: Registration Form
2. **Fill in the form**:
- Full Name: Your complete name
- Project Name: Name of your business/project (e.g., "My E-commerce Bot")
- Email Address: Valid email for verification
3. **Submit** and wait for confirmation
## ✉️ Email Verification
1. Check your email for a message from Openlyne API
2. Copy the 6-digit OTP from the email
3. Visit: Confirm Email
4. Enter your email address and OTP code
5. Click "Verify Email"
## 🔑 API Credentials
After email confirmation, you'll receive your API credentials:
```
API Key: ol_alpha_xxxxxxxxxxxxxxxxxxxxx
Webhook URL: webhook.openlyne.com
Base API URL: api.openlyne.com
```
> ⚠️ **Important**: Keep these credentials secure and never commit them to version control!
## 📱 WhatsApp Connection
1. **Request connection**: Request Connection
2. Enter your registered email address
3. Wait for OTP via SMS or WhatsApp (2-3 minutes)
4. **Verify OTP**: Enter OTP
5. **Scan QR Code**:
- Open WhatsApp on your phone
- Go to Menu (⋮) → "Linked Devices"
- Tap "Link a Device"
- Scan the QR code displayed on your screen
## 📤 Sending Messages
### cURL Example
```bash
curl -X POST "api.openlyne.com" \
-H "Authorization: Bearer ol_alpha_xxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"phone_number": "+234xxxxxxxxxx",
"message": "Hello from Openlyne API! 🚀"
}'
```
### Python Exa …