Todennus

SMSBAT ChatHub API käyttää kaksitasoista JWT-tunnuspohjaista todennusjärjestelmää, jossa on yrityksen tokeneita ja operaattoritunnuksia.

Todennuskulku

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]

Yrityksen tunnus

Yritystunnukset tarjoavat organisaatiotason pääsyn ChatHub API:lle.

Hanki yrityksen tunnus

Päätepiste: "POST /api/company/get-token".

Pyyntö:

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"
  }'

Pyynnön elin:

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

Vastaus:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"

Vastaus on JWT-merkkijono.

Käytä yritystunnusta

Sisällytä yrityksen tunnus API-pyyntöihin jollakin seuraavista tavoista:

Tapa 1: Valtuutusotsikko (suositus)

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

Tapa 2: X-Authorization-Key Header

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

Operaattorin tunnus

Operaattoritunnukset tarjoavat käyttäjäkohtaisen pääsyn organisaation yksittäisille operaattoreille.

Hanki operaattoritunnus

Päätepiste: "POST /api/operator/get-token".

Pyyntö:

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"
  }'

Pyynnön elin:

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

Parametrit:

Parametri	Tyyppi	Pakollinen	Kuvaus
"id"	kokonaisluku	Kyllä	Käyttäjätunnus
vanhenee	merkkijono (ISO 8601)	Kyllä	Tokenin viimeinen voimassaolopäivä ja -aika (enintään 24 tunnin kuluttua)

Tärkeää: Tokenin enimmäiskesto on 24 tuntia. ExpiresAt-parametri voi olla enintään 24 tuntia tulevaisuudessa.

Vastaus:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcGVyYXRvcl9pZCI6MTIzLCJleHAiOjE3Mzc0MTI3OTl9.example_signature"

Käytä operaattoritunnusta

Sisällytä operaattoritunnus API-pyyntöihin:

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

Tokenin vahvistus

Varmista, että tunnus on edelleen voimassa, ennen kuin käytät sitä.

Päätepiste: "POST /api/operator/validate-token".

Pyyntö:

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

Pyynnön elin:

{
  "token": "string"
}

Vastaus (voimassa oleva tunnus):

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

Vastaus (virheellinen tunnus):

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

Tokenin vanheneminen

Yritystunnukset

• API:ssa ei ole nimenomaista vanhenemista
• Ota yhteyttä tilivastaavaasi saadaksesi tunnuksen elinkaarikäytännöt
• Kierrä tokeneita säännöllisesti turvallisuuden vuoksi

Operaattorin tunnukset

• Vanheneminen asetettu pyydettäessä oikeutta ("expiresAt" -parametri)
• Vahvista tokenit ennen käyttöä
• Pyydä uusia tokeneja ennen vanhenemista

Toteutusesimerkkejä

Python

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');

Parhaat käytännöt

Token-tallennus

• ✅ Säilytä tokeneita turvallisesti (salattu tietokanta, salaisuuksien hallinta)
• ✅ Älä koskaan sitoa tunnuksia versionhallintaan
• ✅ Käytä käyttöoikeustiedoissa ympäristömuuttujia
• ❌ Älä säilytä tunnuksia pelkkänä tekstinä
• ❌ Älä paljasta tunnuksia asiakaspuolen koodissa

Token Rotation

• Vuorottele yrityksen tokeneja säännöllisesti (3–6 kuukauden välein)
• Aseta käyttäjätunnuksille kohtuullinen voimassaoloaika (7-30 päivää)
• Ota käyttöön automaattinen tunnuksen päivitys ennen vanhenemista
• Peruuta tunnukset, kun käyttäjät lähtevät

Virheiden käsittely

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)
      );
    }
  }
}

Tokenin vahvistus

Vahvista tunnukset aina ennen kriittisiä toimintoja:

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();
}

Turvallisuusnäkökohdat

Vain HTTPS

Käytä aina HTTPS:ää, kun lähetät todennuspyyntöjä:

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

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

Tokenin laajuus

Käytä kullekin toiminnolle asianmukaista tunnusta:

• Yritystunnus: Organisaation hallinta, operaattorin luominen
• Operator Token: Chat-toiminnot, viestien käsittely

Hintarajoitus

Todennuspyyntöjen nopeusrajoituksen käyttöönotto:

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);
  }
}

Vianetsintä

401 Luvaton

• Tarkista, että tunnistetiedot ovat oikein
• Check token ei ole vanhentunut
• Varmista, että tunnus on sisällytetty pyyntöjen otsikoihin
• Vahvista tunnuksen muoto

403 Kielletty

• Varmista, että tunnuksella on vaadittavat käyttöoikeudet
• Tarkista, käytätkö oikeaa merkkityyppiä (yritys vs. operaattori)
• Varmista, että tunnusta ei ole peruutettu

Token vanhentunut

• Pyydä uusi tunnus
• Ota käyttöön automaattinen tunnuksen päivitys
• Aseta sopivat vanhentumisajat

Seuraavat vaiheet

• Organisaatiot - Hallinnoi organisaatioita
• Operaattorit - Työskentele operaattoreiden kanssa
• Widgetin integrointi - Integroi chat-widget