Hướng dẫn cài đặt API (Swagger API)

Chức năng API này có thể được sử dụng để thực hiện các thay đổi đối với các tệp cấu hình của bạn mà không cần mở GUI. Nó được thiết kế để sử dụng với các kịch bản bên ngoài cho phép bạn tự động hóa một số khía cạnh của các thay đổi cấu hình dựa trên các tín hiệu bên ngoài của riêng bạn.

Bạn có thể truy cập API cho bot của mình bằng cách truy cập http://localhost:8081/swagger-ui.html.

Khi tải, bạn sẽ thấy màn hình này.

Từ danh sách thả xuống trong tiêu đề, bạn có hai tùy chọn. Chọn settings-api (/v2/api-docs?group=settings-api) hoặc api (/v2/api-docs?group=api).

Cài đặt-API phải được xác thực bằng giấy phép ProfitTrailer.

Ấn vào Show/Hide Toggle hoặc List Operations để hiển thị các tùy chọn có sẵn. Bạn có thể nhấp vào một thao tác để mở rộng nó hoặc sử dụng Expand Operations để mở rộng tất cả.

  • - Xóa cấu hình đã được đặt tên.
  • - Liệt kê tất cả các cấu hình gắn liền với giấy phép.
  • - Chuyển cấu hình đang hoạt động.
  • - Hiển thị nội dung của tập tin cấu hình được chọn.
  • - Ghi đè lên nội dung của tập tin cấu hình được chọn.

Delete

Thao tác xóa cho phép bạn xóa cấu hình dựa trên tên duy nhất của nó.

Thông số:

  • configName - Tên cấu hình bạn muốn xóa
  • license - Giấy phép ProfitTrailer của bạn

Điền vào hai tham số và nhấn vào để xóa cấu hình đã chọn.


List

Thao tác liệt kê liệt kê tất cả các cấu hình được đặt tên được kết nối với khóa API mặc định đang được sử dụng.

Thông số:

  • license - Giấy phép ProfitTrailer của bạn

Điền vào giấy phép và nhấn vào để xem danh sách các cấu hình được đặt tên.

Đây là một ví dụ về đầu ra:


Switch

Thao tác chuyển đổi thay đổi từ cấu hình có tên này sang cấu hình khác.

Thông số:

  • configName - Tên cấu hình bạn muốn kích hoạt
  • license - Giấy phép ProfitTrailer của bạn

Điền vào hai tham số và nhấn vào để làm cho cấu hình được chọn cấu hình hoạt động.


Load

Thao tác tải cho phép bạn xem nội dung của một tệp cấu hình cụ thể.

Thông số:

  • fileName - Tên của tệp cấu hình cụ thể
  • configName - Tên cấu hình
  • license - Giấy phép ProfitTrailer của bạn

Chọn tên tệp mong muốn, điền vào ba tham số và nhấn vào để xem tập tin cấu hình đã chọn.

Đây là một ví dụ về đầu ra:


Save

Chức năng này không hoạt động trong thời điểm hiện tại.

Thông số:

  • fileName - Tên của tệp cấu hình cụ thể
  • configName - Tên cấu hình
  • saveData - Nội dung (cài đặt) bạn muốn ghi đè lên tập tin.
  • license - Giấy phép ProfitTrailer của bạn

API yêu cầu server.api_token để xác thực các cuộc gọi.

Ấn vào Show/Hide Toggle hoặc List Operations để hiển thị các tùy chọn có sẵn. Bạn có thể nhấp vào một thao tác để mở rộng nó hoặc sử dụng Expand Operations để mở rộng tất cả.

  • vn/swagger_api.txt
  • Last modified: 9 months ago
  • by mightaswell