Hướng dẫn tạo APY KEY

API Key cho phép ứng dụng bên ngoài xác thực và gọi các API của Alohub. Mỗi API Key được gắn với một tài khoản tenant và có thể giới hạn phạm vi truy cập (scopes) theo nhu cầu.

Lưu ý: API Key chỉ hiển thị một lần duy nhất sau khi tạo. Hãy sao chép và lưu trữ ở nơi an toàn ngay lập tức. Nếu mất key, bạn cần tạo lại (regenerate) key mới.

Hướng dẫn tạo API Key trên giao diện

Bước 1: Truy cập trang API Keys

Từ thanh menu bên trái, chọn Tích hợp (Integration) → API Keys. Trang quản lý API Keys sẽ hiển thị danh sách các key đã tạo.

Bước 2: Mở form tạo API Key

Nhấn nút Tạo API Key mới ở góc trên bên phải. Một dialog sẽ mở ra với các trường thông tin cần điền.

Bước 3: Điền thông tin

Bước 4: Xác nhận tạo

Nhấn nút Tạo API Key để hoàn tất. Hệ thống sẽ hiển thị dialog chứa giá trị API Key vừa tạo.

Bước 5: Sao chép và lưu trữ API Key

Dialog hiện ra sẽ chứa giá trị API Key đầy đủ. Nhấn nút Copy để sao chép key vào clipboard, sau đó lưu vào nơi an toàn (biến môi trường, vault, password manager).

Cảnh báo: Key này sẽ không hiển thị lại sau khi bạn đóng dialog. Nếu chưa copy mà đã đóng, bạn sẽ cần tạo lại (regenerate) key mới.

Sau khi đã lưu key, nhấn Đã lưu, đóng để hoàn tất.

Bảng phạm vi truy cập (Scopes)

Quản lý API Key sau khi tạo

Sau khi tạo thành công, API Key sẽ xuất hiện trong bảng danh sách với các thông tin:

• Tên — tên bạn đã đặt khi tạo

• API Key — giá trị key dạng ẩn (masked), có nút copy để sao chép nhanh

• Phạm vi — các scopes đã cấp, hiển thị dưới dạng tag màu

• Trạng thái — Đang hoạt động (xanh) hoặc Không hoạt động

• Ngày tạo — thời gian tạo key

• Lần cuối dùng — thời gian gọi API gần nhất bằng key này

Nhấn biểu tượng ⋮ (menu) ở cuối mỗi dòng để truy cập các hành động: Tạo lại key (regenerate) hoặc Thu hồi key (revoke).

Tạo API Key qua API

POST /api/v1.0/integration/api-keys

Ngoài giao diện, bạn có thể tạo API Key bằng cách gọi trực tiếp endpoint này.

Headers

Body Parameters

Code mẫu

curl -X POST "{{protocol}}://{{host}}:{{port}}/api/v1.0/integration/api-keys" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Key tích hợp CRM",
    "scopes": ["callcenter", "contacts"],
    "expiresInDays": 90
  }'

const axios = require('axios')

const response = await axios.post(
  '{{protocol}}://{{host}}:{{port}}/api/v1.0/integration/api-keys',
  {
    name: 'Key tích hợp CRM',
    scopes: ['callcenter', 'contacts'],
    expiresInDays: 90
  },
  {
    headers: {
      'Authorization': 'Bearer {{token}}',
      'Content-Type': 'application/json'
    }
  }
)

// Lưu ý: key chỉ trả về 1 lần duy nhất — lưu ngay
console.log('API Key:', response.data.key)

import requests

url = '{{protocol}}://{{host}}:{{port}}/api/v1.0/integration/api-keys'
headers = {
    'Authorization': 'Bearer {{token}}',
    'Content-Type': 'application/json'
}
payload = {
    'name': 'Key tích hợp CRM',
    'scopes': ['callcenter', 'contacts'],
    'expiresInDays': 90
}

response = requests.post(url, json=payload, headers=headers)

# Lưu ý: key chỉ trả về 1 lần duy nhất — lưu ngay
data = response.json()
print('API Key:', data['key'])

Response thành công

HTTP 200 OK

{
  "id": "key_abc123def456",
  "name": "Key tích hợp CRM",
  "key": "alo_k_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "scopes": ["callcenter", "contacts"],
  "createdAt": "2026-04-07T10:30:00.000Z"
}

Mô tả Response

Lỗi thường gặp

Bảo mật: Không chia sẻ API Key qua email, chat hoặc lưu trong source code. Sử dụng biến môi trường (environment variables) để quản lý key trong ứng dụng của bạn.