API प्रमाणीकरण
JWT टोकन का उपयोग करके BotLaunch API के साथ प्रमाणित करना सीखें। अपने अनुरोधों को सुरक्षित करें और अपने संसाधनों तक पहुंच प्रबंधित करें।
JSON Web Tokens का उपयोग करके सुरक्षित स्टेटलेस प्रमाणीकरण।
Access टोकन 1 घंटे में समाप्त होते हैं, refresh टोकन 7 दिनों में।
नए access टोकन सहजता से प्राप्त करने के लिए refresh टोकन का उपयोग करें।
प्रमाणीकरण प्रवाह
प्रमाणित करने और सुरक्षित API अनुरोध करने के लिए इन चरणों का पालन करें।
लॉगिन
क्रेडेंशियल्स के साथ टोकन प्राप्त करें
टोकन स्टोर करें
दोनों टोकन सुरक्षित रूप से स्टोर करें
अनुरोध करें
Headers में टोकन शामिल करें
रिफ्रेश
समाप्त होने पर नया टोकन प्राप्त करें
प्रमाणीकरण Endpoints
/api/auth/loginउपयोगकर्ता को प्रमाणित करें और access और refresh टोकन प्राप्त करें।
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| string | User's email address | ||
| password | string | User's password |
Example Request
curl -X POST "https://api.botlaunch.io/api/auth/login" \
-H "Content-Type: application/json" \
-d '{
"email": "user@example.com",
"password": "your-secure-password"
}'Example Response
{
"data": {
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"expiresIn": 3600,
"user": {
"id": "usr_abc123",
"email": "user@example.com",
"role": "CLIENT_OWNER"
}
},
"message": "Login successful"
}/api/auth/registerनया उपयोगकर्ता खाता और संगठन बनाएं।
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| string | Valid email address | ||
| password | string | Min 8 chars, 1 uppercase, 1 number | |
| name | string | User's full name | |
| organizationName | string | Optional | Organization name |
Example Request
curl -X POST "https://api.botlaunch.io/api/auth/register" \
-H "Content-Type: application/json" \
-d '{
"email": "newuser@example.com",
"password": "SecureP@ssw0rd!",
"name": "John Doe",
"organizationName": "My Company"
}'/api/auth/refreshनया access टोकन प्राप्त करने के लिए refresh टोकन का आदान-प्रदान करें।
Example Request
curl -X POST "https://api.botlaunch.io/api/auth/refresh" \
-H "Content-Type: application/json" \
-d '{
"refreshToken": "your-refresh-token"
}'टोकन रोटेशन
प्रत्येक refresh अनुरोध एक नया refresh टोकन लौटाता है। बाद के अनुरोधों के लिए नवीनतम refresh टोकन स्टोर करें और उपयोग करें।
/api/auth/logoutवर्तमान सत्र को अमान्य करें और टोकन रद्द करें।
Example Request
curl -X POST "https://api.botlaunch.io/api/auth/logout" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json"Access टोकन का उपयोग
सभी API अनुरोधों के लिए Authorization header में अपना access टोकन शामिल करें।
// Include the access token in all API requests
const response = await fetch("https://api.botlaunch.io/api/bots", {
headers: {
"Authorization": "Bearer eyJhbGciOiJIUzI1NiIs...",
"x-organization-id": "org_xyz789",
"Content-Type": "application/json"
}
});आवश्यक Headers
AuthorizationBearer tokenx-organization-idOrganization IDContent-Typeapplication/jsonसुरक्षा सर्वोत्तम प्रथाएं
- टोकन सुरक्षित रूप से स्टोर करें (वेब के लिए कभी localStorage में नहीं)
- सभी API अनुरोधों के लिए HTTPS का उपयोग करें
- समाप्ति से पहले टोकन refresh लागू करें
- लॉगआउट या सुरक्षा घटनाओं पर टोकन रद्द करें
प्रमाणीकरण त्रुटियां
सामान्य प्रमाणीकरण त्रुटियां और उन्हें कैसे संभालें।
| Status | Error | Description | Solution |
|---|---|---|---|
| 401 | Unauthorized | Missing or invalid token | Check Authorization header |
| 401 | Token Expired | Access token has expired | Use refresh token to get new access token |
| 403 | Forbidden | Insufficient permissions | Check user role and organization access |
| 429 | Too Many Requests | Login rate limit exceeded | Wait and retry after cooldown |
| 400 | Invalid Credentials | Wrong email or password | Verify credentials and try again |