Skip to content

प्रमाणीकरण

SMSBAT ChatHub API ले कम्पनी टोकन र अपरेटर टोकनहरूसँग दुई-स्तर JWT टोकन-आधारित प्रमाणीकरण प्रणाली प्रयोग गर्दछ।

प्रमाणीकरण प्रवाह

graph TD
    A[Login Credentials] --> B[Get Company Token]
    B --> C[Use Company Token]
    C --> D[Get Operator Token]
    D --> E[Use Operator Token]
    E --> F[Validate Token]

कम्पनी टोकन

कम्पनी टोकनहरूले ChatHub API मा संगठन-स्तर पहुँच प्रदान गर्दछ।

कम्पनी टोकन प्राप्त गर्नुहोस्

अन्तबिन्दु: POST /api/company/get-token

अनुरोध:

curl -X POST https://chatapi.smsbat.com/api/company/get-token \
  -H "Content-Type: application/json" \
  -d '{
    "login": "your-company-login",
    "password": "your-company-password"
  }'

अनुरोध निकाय:

{
  "login": "string",
  "password": "string"
}

प्रतिक्रिया:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

प्रतिक्रिया एक JWT टोकन स्ट्रिङ हो।

कम्पनी टोकन प्रयोग गर्नुहोस्

एपीआई अनुरोधहरूमा दुई मध्ये एउटा विधि प्रयोग गरेर कम्पनी टोकन समावेश गर्नुहोस्:

विधि १: प्राधिकरण हेडर (सिफारिस गरिएको)

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

विधि २: एक्स-प्राधिकरण-कुञ्जी हेडर

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

अपरेटर टोकन

अपरेटर टोकनहरूले संगठन भित्र व्यक्तिगत अपरेटरहरूको लागि प्रयोगकर्ता-विशेष पहुँच प्रदान गर्दछ।

अपरेटर टोकन प्राप्त गर्नुहोस्

अन्तबिन्दु: POST /api/operator/get-token

अनुरोध:

curl -X POST https://chatapi.smsbat.com/api/operator/get-token \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 123,
    "expiresAt": "2025-12-31T23:59:59Z"
  }'

अनुरोध निकाय:

{
  "id": 0,
  "expiresAt": "2025-01-20T14:33:34.147Z"
}

** प्यारामिटरहरू:**

प्यारामिटर प्रकार आवश्यक विवरण
id पूर्णांक हो अपरेटर ID
समाप्तिमा स्ट्रिङ (ISO 8601) हो टोकनको म्याद सकिने मिति र समय (अबबाट अधिकतम २४ घण्टा)

महत्वपूर्ण: अधिकतम टोकन जीवनकाल 24 घण्टा हो। 'expiresAt' प्यारामिटर भविष्यमा 24 घण्टा भन्दा बढी हुन सक्दैन।

प्रतिक्रिया:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcGVyYXRvcl9pZCI6MTIzLCJleHAiOjE3Mzc0MTI3OTl9.example_signature"

अपरेटर टोकन प्रयोग गर्नुहोस्

API अनुरोधहरूमा अपरेटर टोकन समावेश गर्नुहोस्:

curl -X GET https://chatapi.smsbat.com/api/operator \
  -H "Authorization: Bearer {operator-token}"

टोकन प्रमाणीकरण

यो प्रयोग गर्नु अघि टोकन अझै मान्य छ भनेर प्रमाणित गर्नुहोस्।

अन्तबिन्दु: POST /api/operator/validate-token

अनुरोध:

curl -X POST https://chatapi.smsbat.com/api/operator/validate-token \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }'

अनुरोध निकाय:

{
  "token": "string"
}

प्रतिक्रिया (वैध टोकन):

{
  "isValid": true,
  "operatorId": 123,
  "clientId": 0,
  "expiresAt": "2025-12-31T23:59:59Z",
  "error": null
}

प्रतिक्रिया (अमान्य टोकन):

{
  "isValid": false,
  "error": "Invalid token"
}

टोकन म्याद समाप्ति

कम्पनी टोकनहरू

  • API मा कुनै स्पष्ट म्याद समाप्ति छैन
  • टोकन जीवनचक्र नीतिहरूको लागि आफ्नो खाता प्रबन्धकलाई सम्पर्क गर्नुहोस्
  • सुरक्षाको लागि आवधिक रूपमा टोकनहरू घुमाउनुहोस्

अपरेटर टोकनहरू

  • टोकन अनुरोध गर्दा म्याद समाप्ति सेट (expiresAt प्यारामिटर)
  • प्रयोग गर्नु अघि टोकन प्रमाणित गर्नुहोस्
  • म्याद समाप्त हुनु अघि नयाँ टोकनहरू अनुरोध गर्नुहोस्

कार्यान्वयन उदाहरणहरू

पाइथन

import requests
from datetime import datetime, timedelta

class ChatHubAuth:
    def __init__(self, base_url):
        self.base_url = base_url
        self.company_token = None
        self.operator_tokens = {}

    def get_company_token(self, login, password):
        """Get company authentication token"""
        response = requests.post(
            f"{self.base_url}/api/company/get-token",
            json={"login": login, "password": password}
        )
        response.raise_for_status()
        self.company_token = response.json()
        return self.company_token

    def get_operator_token(self, operator_id, expires_days=30):
        """Get operator token with expiration"""
        expires_at = (
            datetime.utcnow() + timedelta(days=expires_days)
        ).isoformat() + "Z"

        response = requests.post(
            f"{self.base_url}/api/operator/get-token",
            headers={"Authorization": f"Bearer {self.company_token}"},
            json={"id": operator_id, "expiresAt": expires_at}
        )
        response.raise_for_status()

        token = response.json()
        self.operator_tokens[operator_id] = token
        return token

    def validate_token(self, token):
        """Validate if token is still valid"""
        response = requests.post(
            f"{self.base_url}/api/operator/validate-token",
            headers={"Authorization": f"Bearer {self.company_token}"},
            json={"token": token}
        )
        response.raise_for_status()
        return response.json()

# Usage
auth = ChatHubAuth("https://chatapi.smsbat.com")

# Get company token
company_token = auth.get_company_token("login", "password")

# Get operator token
operator_token = auth.get_operator_token(operator_id=123, expires_days=30)

# Validate token
is_valid = auth.validate_token(operator_token)
print(f"Token valid: {is_valid['valid']}")

JavaScript (Node.js)

const axios = require('axios');

class ChatHubAuth {
  constructor(baseUrl) {
    this.baseUrl = baseUrl;
    this.companyToken = null;
    this.operatorTokens = {};
  }

  async getCompanyToken(login, password) {
    const response = await axios.post(
      `${this.baseUrl}/api/company/get-token`,
      { login, password }
    );

    this.companyToken = response.data;
    return this.companyToken;
  }

  async getOperatorToken(operatorId, expiresDays = 30) {
    const expiresAt = new Date(
      Date.now() + expiresDays * 24 * 60 * 60 * 1000
    ).toISOString();

    const response = await axios.post(
      `${this.baseUrl}/api/operator/get-token`,
      { id: operatorId, expiresAt },
      {
        headers: {
          Authorization: `Bearer ${this.companyToken}`
        }
      }
    );

    const token = response.data;
    this.operatorTokens[operatorId] = token;
    return token;
  }

  async validateToken(token) {
    const response = await axios.post(
      `${this.baseUrl}/api/operator/validate-token`,
      { token },
      {
        headers: {
          Authorization: `Bearer ${this.companyToken}`
        }
      }
    );

    return response.data;
  }
}

// Usage
const auth = new ChatHubAuth('https://chatapi.smsbat.com');

async function authenticate() {
  // Get company token
  const companyToken = await auth.getCompanyToken('login', 'password');

  // Get operator token
  const operatorToken = await auth.getOperatorToken(123, 30);

  // Validate token
  const validation = await auth.validateToken(operatorToken);
  console.log('Token valid:', validation.isValid);
}

authenticate();

PHP

<?php

class ChatHubAuth {
    private $baseUrl;
    private $companyToken;
    private $operatorTokens = [];

    public function __construct($baseUrl) {
        $this->baseUrl = $baseUrl;
    }

    public function getCompanyToken($login, $password) {
        $ch = curl_init($this->baseUrl . '/api/company/get-token');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Content-Type: application/json'
        ]);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
            'login' => $login,
            'password' => $password
        ]));

        $response = curl_exec($ch);
        curl_close($ch);

        $this->companyToken = json_decode($response);
        return $this->companyToken;
    }

    public function getOperatorToken($operatorId, $expiresDays = 30) {
        $expiresAt = date(
            'Y-m-d\TH:i:s\Z',
            time() + ($expiresDays * 24 * 60 * 60)
        );

        $ch = curl_init($this->baseUrl . '/api/operator/get-token');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Content-Type: application/json',
            'Authorization: Bearer ' . $this->companyToken
        ]);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
            'id' => $operatorId,
            'expiresAt' => $expiresAt
        ]));

        $response = curl_exec($ch);
        curl_close($ch);

        $token = json_decode($response);
        $this->operatorTokens[$operatorId] = $token;
        return $token;
    }

    public function validateToken($token) {
        $ch = curl_init($this->baseUrl . '/api/operator/validate-token');

        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Content-Type: application/json',
            'Authorization: Bearer ' . $this->companyToken
        ]);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
            'token' => $token
        ]));

        $response = curl_exec($ch);
        curl_close($ch);

        return json_decode($response, true);
    }
}

// Usage
$auth = new ChatHubAuth('https://chatapi.smsbat.com');

// Get company token
$companyToken = $auth->getCompanyToken('login', 'password');

// Get operator token
$operatorToken = $auth->getOperatorToken(123, 30);

// Validate token
$validation = $auth->validateToken($operatorToken);
echo "Token valid: " . ($validation['isValid'] ? 'Yes' : 'No');

उत्तम अभ्यासहरू

टोकन भण्डारण

  • ✅ टोकनहरू सुरक्षित रूपमा भण्डार गर्नुहोस् (इन्क्रिप्टेड डाटाबेस, गोप्य प्रबन्धक)
  • ✅ संस्करण नियन्त्रणमा टोकनहरू कहिल्यै नदिनुहोस्
  • ✅ प्रमाणहरूका लागि वातावरणीय चरहरू प्रयोग गर्नुहोस्
  • ❌ टोकनहरू सादा पाठमा भण्डार नगर्नुहोस्
  • ❌ क्लाइन्ट-साइड कोडमा टोकनहरू नदेखाउनुहोस्

टोकन रोटेशन

  • आवधिक रूपमा कम्पनी टोकनहरू घुमाउनुहोस् (हरेक 3-6 महिनामा)
  • अपरेटर टोकनहरूको लागि उचित म्याद समाप्ति सेट गर्नुहोस् (7-30 दिन)
  • समाप्ति अघि स्वचालित टोकन रिफ्रेस लागू गर्नुहोस्
  • अपरेटरहरू छोड्दा टोकनहरू रद्द गर्नुहोस्

त्रुटि ह्यान्डलिंग

async function authenticateWithRetry(login, password, retries = 3) {
  for (let i = 0; i < retries; i++) {
    try {
      return await getCompanyToken(login, password);
    } catch (error) {
      if (error.response?.status === 401) {
        throw new Error('Invalid credentials');
      }

      if (i === retries - 1) throw error;

      // Wait before retry
      await new Promise(resolve =>
        setTimeout(resolve, Math.pow(2, i) * 1000)
      );
    }
  }
}

टोकन प्रमाणीकरण

सँधै महत्वपूर्ण कार्यहरू अघि टोकनहरू मान्य गर्नुहोस्:

async function performSecureOperation(token, operation) {
  // Validate token first
  const validation = await validateToken(token);

  if (!validation.isValid) {
    throw new Error('Token expired or invalid');
  }

  // Proceed with operation
  return await operation();
}

सुरक्षा विचारहरू

HTTPS मात्र

प्रमाणीकरण अनुरोधहरू पठाउँदा सधैं HTTPS प्रयोग गर्नुहोस्:

// ✅ Correct
const baseUrl = 'https://chatapi.smsbat.com';

// ❌ Wrong - never use HTTP for authentication
const baseUrl = 'http://api.chathub.smsbat.com';

टोकन स्कोप

प्रत्येक कार्यको लागि उपयुक्त टोकन प्रयोग गर्नुहोस्:

  • कम्पनी टोकन: संगठन व्यवस्थापन, अपरेटर निर्माण
  • अपरेटर टोकन: च्याट सञ्चालन, सन्देश ह्यान्डलिंग

दर सीमित

प्रमाणीकरण अनुरोधहरूको लागि सीमा दर लागू गर्नुहोस्:

class RateLimitedAuth {
  constructor() {
    this.lastRequest = 0;
    this.minInterval = 1000; // 1 second between requests
  }

  async getToken(login, password) {
    const now = Date.now();
    const timeSinceLastRequest = now - this.lastRequest;

    if (timeSinceLastRequest < this.minInterval) {
      await new Promise(resolve =>
        setTimeout(resolve, this.minInterval - timeSinceLastRequest)
      );
    }

    this.lastRequest = Date.now();
    return await makeAuthRequest(login, password);
  }
}

समस्या निवारण

४०१ अनाधिकृत

  • प्रमाणहरू सही छन् भनी प्रमाणित गर्नुहोस्
  • चेक टोकन म्याद सकिएको छैन
  • अनुरोध हेडरहरूमा टोकन समावेश गरिएको सुनिश्चित गर्नुहोस्
  • टोकन ढाँचा मान्य गर्नुहोस्

403 निषेधित

  • टोकन आवश्यक अनुमतिहरू प्रमाणित गर्नुहोस्
  • सही टोकन प्रकार (कम्पनी बनाम अपरेटर) प्रयोग गर्दै हुनुहुन्छ भने जाँच गर्नुहोस्
  • निश्चित गर्नुहोस् टोकन रद्द गरिएको छैन

टोकनको म्याद सकियो

  • नयाँ टोकन अनुरोध गर्नुहोस्
  • स्वचालित टोकन रिफ्रेस लागू गर्नुहोस्
  • उपयुक्त म्याद समाप्ति समय सेट गर्नुहोस्

अर्को चरणहरू