Autenticação

A API SMSBAT ChatHub usa um sistema de autenticação baseado em token JWT de dois níveis com tokens de empresa e tokens de operador.

Fluxo de autenticação

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]

Token da Empresa

Os tokens da empresa fornecem acesso em nível de organização à API ChatHub.

Obtenha o token da empresa

Ponto final: POST /api/company/get-token

Solicitação:

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

Corpo da solicitação:

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

Resposta:

CODE_BLOCO_3

A resposta é uma string de token JWT.

Usar token da empresa

Inclua o token da empresa nas solicitações de API usando um dos dois métodos:

Método 1: cabeçalho de autorização (recomendado)

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

Método 2: Cabeçalho X-Authorization-Key

CODE_BLOCO_5

Token do Operador

Os tokens de operador fornecem acesso específico do usuário para operadores individuais dentro de uma organização.

Obter token do operador

Ponto final: POST /api/operator/get-token

Solicitação:

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

Corpo da solicitação:

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

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
id	inteiro	Sim	ID do Operador
expiraEm	cadeia de caracteres (ISO 8601)	Sim	Data e hora de expiração do token (no máximo 24 horas a partir de agora)

Importante: A vida útil máxima do token é de 24 horas. O parâmetro expiresAt não pode ser posterior a mais de 24 horas.

Resposta:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcGVyYXRvcl9pZCI6MTIzLCJleHAiOjE3Mzc0MTI3OTl9.example_signature"

Usar token de operador

Inclua o token do operador nas solicitações de API:

CODE_BLOCO_9

Validação de token

Verifique se um token ainda é válido antes de usá-lo.

Ponto final: POST /api/operator/validate-token

Solicitação:

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

Corpo da solicitação:

{
  "token": "string"
}

Resposta (token válido):

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

Resposta (token inválido):

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

Expiração do token

Tokens da Empresa

• Nenhuma expiração explícita na API
• Entre em contato com seu gerente de conta para obter informações sobre as políticas de ciclo de vida do token
• Gire os tokens periodicamente para segurança

Tokens de Operador

• Expiração definida ao solicitar token (parâmetro expiresAt)
• Valide os tokens antes de usar
• Solicite novos tokens antes da expiração

Exemplos de implementação

Píton

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

Melhores práticas

Armazenamento de tokens

• ✅ Armazene tokens com segurança (banco de dados criptografado, gerenciador de segredos)
• ✅ Nunca envie tokens para controle de versão
• ✅ Use variáveis de ambiente para credenciais
• ❌ Não armazene tokens em texto simples
• ❌ Não exponha tokens no código do lado do cliente

Rotação de token

• Alterne os tokens da empresa periodicamente (a cada 3-6 meses)
• Defina uma expiração razoável para tokens de operador (7 a 30 dias)
• Implementar atualização automática de token antes da expiração
• Revogar tokens quando os operadores saírem

Tratamento de erros

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

Validação de token

Sempre valide os tokens antes de operações críticas:

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

Considerações de segurança

Somente HTTPS

Sempre use HTTPS ao enviar solicitações de autenticação:

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

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

Escopo do token

Use o token apropriado para cada operação:

• Token da Empresa: gerenciamento da organização, criação de operadores
• Token do Operador: operações de bate-papo, tratamento de mensagens

Limitação de taxa

Implemente a limitação de taxa para solicitações de autenticação:

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

Solução de problemas

401 Não autorizado

• Verifique se as credenciais estão corretas
• Verifique se o token não expirou
• Certifique-se de que o token esteja incluído nos cabeçalhos da solicitação
• Validar formato de token

403 Proibido

• Verifique se o token requer permissões
• Verifique se está usando o tipo de token correto (empresa vs operadora)
• Certifique-se de que o token não foi revogado

Token Expirado

• Solicitar novo token
• Implementar atualização automática de token
• Defina tempos de expiração apropriados

Próximas etapas

• Organizações - Gerenciar organizações
• Operadores - Trabalhar com operadores
• Integração de widget - Integrar widget de chat