Tài liệu kỹ thuật VSH Open API

1. Giới thiệu chung

VSH Open Data API là cổng chia sẻ dữ liệu học thuật chính thống của hệ sinh thái Vietnam ScholarHub (VSH). Hệ thống cung cấp khả năng truy xuất siêu dữ liệu bài báo khoa học kèm theo các chỉ số định lượng về uy tín và tầm ảnh hưởng của học giả tại Việt Nam.

2. Thông tin kết nối

• Base URL: https://scholar.com.vn/wp-json/vsh/v2

• Giao thức: HTTPS (Bắt buộc)

• Định dạng dữ liệu: JSON (UTF-8)

3. Cơ chế Xác thực & Bảo mật

Để truy xuất dữ liệu, đối tác cần sử dụng API Key được cấp bởi Ban Quản trị VSH.

• Header Name: X-VSH-API-KEY

• Cơ chế bảo vệ: Hệ thống áp dụng Rate Limiting (Giới hạn 12 lượt gọi/phút). Mọi hành vi cào dữ liệu (Scraping) bất thường sẽ bị chặn IP tự động.

4. Endpoint Chi tiết

GET /articles

Truy xuất danh sách bài báo khoa học và các chỉ số đo lường.

Tham số Truy vấn (Query Parameters):

| Tham số | Kiểu dữ liệu | Mô tả |

| :— | :— | :— |

| search | String | (Tùy chọn) Tìm kiếm theo tiêu đề hoặc từ khóa. |

Cấu trúc dữ liệu phản hồi (JSON):

5. Ví dụ kết nối (Code Snippets)

Dành cho Lập trình viên PHP (WordPress/Laravel)

$api_key = 'KHÓA_API_CỦA_BẠN';
$response = wp_remote_get('https://scholar.com.vn/wp-json/vsh/v2/articles', [
    'headers' => [
        'X-VSH-API-KEY' => $api_key,
        'Content-Type'  => 'application/json'
    ]
]);

if (!is_wp_error($response)) {
    $data = json_decode(wp_remote_retrieve_body($response));
    // Xử lý hiển thị dữ liệu bài báo ra website đối tác
}

Dành cho Lập trình viên Python (Data Science/Research)

import requests

url = "https://scholar.com.vn/wp-json/vsh/v2/articles"
headers = {
    "X-VSH-API-KEY": "KHÓA_API_CỦA_BẠN"
}

response = requests.get(url, headers=headers)
articles = response.json()

for art in articles:
    print(f"Tiêu đề: {art['title']} - Uy tín tác giả: {art['metrics']['author_vsh_score']}")

6. Danh mục mã lỗi (Error Codes)

• 401 Unauthorized: Thiếu API Key trong Header.

• 403 Forbidden: API Key sai hoặc đã bị khóa do vi phạm chính sách.

• 429 Too Many Requests: Vượt quá hạn mức 12 lượt gọi/phút (Rate limit).

• 500 Internal Server Error: Lỗi máy chủ hệ thống.

7. Quy định sử dụng dữ liệu

1. Ghi nguồn: Mọi dữ liệu trích xuất từ API phải hiển thị kèm dòng chữ: “Nguồn dữ liệu: Vietnam ScholarHub” hoặc “Xác thực bởi VSH Index”.

2. Mục đích: Chỉ sử dụng cho mục đích hiển thị thông tin học thuật, báo cáo nghiên cứu. Không được dùng để xây dựng các công cụ spam hoặc giả mạo học giả.

3. Bảo mật: Không được chia sẻ API Key cho bên thứ ba.

Vietnam ScholarHub Support Team Mọi yêu cầu cấp khóa hoặc hỗ trợ kỹ thuật, vui lòng liên hệ: [email protected]