Chuyển tới nội dung chính

API Keys

Giao diện quản lý API Keys

Chức năng API Keys cho phép tạo và quản lý API key để tích hợp các hệ thống bên ngoài với dịch vụ của VNETWORK. Hệ thống hỗ trợ xác thực theo chuẩn Bearer Token và cung cấp các điểm cuối RESTful API để thao tác dữ liệu hạ tầng.

Vị trí trên hệ thống​

Truy cập mục API Keys trong thanh điều hướng bên trái giao diện Partner Portal.

Giao diện và các thành phần​

Khu vực quản lý API Key​

  • Tài khoản: review@vnetwork.vn (ID: 8064)
  • API Key đang sử dụng:
    • Tên: Development
    • Thời gian tạo: 2025-05-05T13:21:59.880Z
    • Lần sử dụng gần nhất: Chưa từng dùng

Các nút thao tác:

  • Create New Key: Tạo khóa API mới
  • Revoke: Thu hồi khóa hiện tại
  • Copy: Sao chép giá trị khóa để sử dụng
Lưu ý bảo mật

Vì lý do bảo mật, hệ thống không hiển thị lại khóa sau khi đóng. Cần sao lưu ngay sau khi tạo.

Tài liệu API (API Documentation)​

VNETWORK OpenAPI​

Cung cấp các endpoint RESTful để thao tác với dịch vụ VNETWORK, bao gồm:

  • Quản lý hạ tầng cloud (instances, storage, network)
  • Thực hiện thao tác CRUD
  • Truy xuất thông tin hệ thống
  • Tự động hóa quy trình

Authorization​

Phương thức xác thực sử dụng Bearer Token:

Bearer Token: {OPENAPI_TOKEN}

API key sẽ được sử dụng ở định dạng:

Authorization: Bearer YOUR_API_KEY_HERE

API Endpoints​

  • Base URL: https://openapi.vnetwork.vn/v1
  • Ví dụ endpoint: https://openapi.vnetwork.vn/v1/instances → Lấy danh sách các instances liên kết với tài khoản xác thực.

CURL Testing Example​

Ví dụ thực thi qua CURL:

curl -X GET https://openapi.vnetwork.vn/v1/instances \
  -H "Authorization: Bearer YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json"

Thay thế YOUR_API_KEY_HERE bằng khóa API đang được tạo ở phần trên.

Documentation Resources​

⚠️ Lưu ý quan trọng​

Bảo mật API Key
  • API Key cần được lưu trữ an toàn, không để lộ trong mã nguồn phía client hoặc public repository
  • Khóa API có giá trị như một mật khẩu và có thể được sử dụng để truy cập vào tài nguyên của bạn
  • Nên sử dụng biến môi trường hoặc vault để lưu trữ API key trong ứng dụng
Quản lý key hiệu quả
  • Đặt tên key theo mục đích sử dụng để dễ quản lý (ví dụ: "Development", "Production", "Testing")
  • Định kỳ xoay vòng (rotate) API key để tăng tính bảo mật
  • Mỗi API Key có thể thu hồi riêng lẻ nếu bị rò rỉ mà không ảnh hưởng đến các key khác

Các trường hợp sử dụng phổ biến​

  1. Tích hợp hệ thống quản lý bên thứ ba: Kết nối hệ thống quản lý nội bộ với hạ tầng VNETWORK
  2. Tự động hóa quy trình DevOps: Tự động tạo/quản lý tài nguyên trong CI/CD pipeline
  3. Giám sát tài nguyên: Thu thập metrics về hiệu suất và trạng thái của instance
  4. Quản lý tài nguyên tự động: Tự động điều chỉnh tài nguyên dựa trên nhu cầu thực tế