Tài liệu Steamworks
Xác thực bằng khóa API Web
Một số phương thức API Web trả về dữ liệu có thể truy cập công khai và không cần thẩm quyền khi được gọi. Các phương thức khác có thể cần bạn sử dụng một khóa API độc nhất. Ngoài ra cũng có phương thức trả về dữ liệu nhạy cảm hoặc thực hiện hành động được bảo vệ và cần phải có quyền truy cập đặc biệt. Cái API này cần khóa nhà phát hành, mà bạn sẽ cần phải tạo trước khi gọi chúng. Trong trường hợp cần tới khóa API, nó có thể được cung cấp bởi một tham số tiêu chuẩn hoặc bằng cách thiết lập giá trị tiêu đề cho yêu cầu e 'x-webapi-key'.

Khóa của người dùng

Khóa tiêu chuẩn của người dùng thì ai cũng có, chỉ cần có tài khoản Steam và tên miền để liên kết với khóa này.

Bạn cũng sẽ cần phải đồng ý với điều khoản sử dụng API web của Steam.

Bạn có thể tạo một khóa API Web người dùng từ trang đăng ký trên cộng đồng Steam.

Khóa của nhà phát hành

Để an toàn xác nhận một nhà phát hành, và cho phép truy cập các phương thức được bảo vệ, một nhà phát hành có thể yêu cầu khóa API Web mà có thể được chuyển tới phương thức phù hợp qua tham số của khóa. Mỗi khóa được liên kết với nhóm nhà phát hành và có thể được dùng để truy cập dữ liệu cho tất cả ID ứng dụng được gắn kết với nhóm đấy. Để nhận khóa API Web nhà phát hành, xem mục "Tạo khóa API web nhà phát hành" bên dưới.

Khóa API Web nhà phát hành cho quyền truy cập tới dữ liệu nhạy cảm của người dùng và các phương thức được bảo vệ. Các khóa này có mục đích để dùng cho yêu cầu API Web có nguồn gốc từ máy chủ bảo mật của nhà phát hành. Khóa phải được lưu trữ bảo mật, và không được phát hành cùng phần mềm trò chơi. Tất cả yêu cầu API Web mà có chứa khóa API Web nên được thực hiện qua HTTPS.

Tạo khóa API Web nhà phát hành

Để tạo khóa API Web nhà phát hành, bạn sẽ cần có quyền quản trị viên bên trong tài khoản Steamworks hiện hữu. Nếu không phải là quản trị viên, bạn có thể xem danh sách quản trị viên cho tài khoản đối tác bằng cách đến trang chủ Steamworks và xem danh sách này bên tay phải. Bất kỳ ai trong đó cũng có thể tạo khóa API Web nhà phát hành hoặc thăng bạn lên cấp quản trị viên nếu phù hợp.

Để tạo khóa API Web nhà phát hành:
  1. Với tư cách người dùng có quyền quản trị trong tài khoản Steamworks, trước tiên hãy vào danh sách nhóm của bạn bằng cách tới Người dùng & quyền hạn, sau đó vào Quản lý nhóm.
  2. Từ danh sách nhóm, chọn hoặc tạo một nhóm có chứa ID ứng dụng (App ID) mà bạn muốn có quyền truy cập với khóa WebAPI.
  3. Rồi nhấp vào nhóm đó để xem người dùng và ứng dụng trong nhóm đó.
  4. Nếu có quyền quản trị, bạn sẽ thấy tùy chọn để "Tạo khóa WebAPI" nằm ở bên tay phải. Hoặc bạn sẽ thấy khóa được liệt kê nếu nó đã được tạo.