1.Overview
Chương trình API công khai của Sophos Central giúp bạn dễ dàng tự động hóa các hoạt động giám sát, bảo mật và quản trị của mình trong Sophos Central. Bạn có thể làm nhiều việc mà bạn thường làm trong Sophos Central Admin hoặc Sophos Central Partner.
Bài viết sẽ hướng dẫn các bạn tạo API Credentials Management trên Sophos Central cũng như các yêu cầu trên endpoint để có thể sử dụng call API lấy các thông tin như thiết bị, sự kiện, chính sách có trên Central của mình.
2. Hướng dẫn
Bước 1: Tạo API Credentials Mangement trên Sophos Central.
API Credentials là một tập hợp các thông tin xác thực có thể được sử dụng để xác thực và gọi các API.
Login vào Sophos Central > Gloabal Settings > Administration > API Credentials Mangement.
Note: Yêu cầu Login với vai trò Super Admin
Tại Credentials tab, click chọn Add Credentials.
Trong Add Credentials:
Credentials Name: Điền tên bạn muốn
Roles: chọn Service Principal Super Admin (Với vai trò Super Admin bạn sẽ có toàn quyền truy cập vào tất cả các API công khai trong Sophos Central).
Click Add.
Bạn copy lấy phần Client ID và Client Secret và paste vào note. Phần Client Secret sẽ bị dấu đi sau một thời gian. Nên nếu bạn không note lại Client Secret, khi cần lấy thông tin này, bạn sẽ cần xóa và tạo lại Credentials.
Bước 2: Yêu cầu trên Endpoint trước khi call API
Trên endpoint sử dụng để chạy các lệnh call API kết hợp code Python bạn cần cài đặt tool python để chạy các code này trên CMD của Endpoint. Mặc định CMD sẽ không hiểu lệnh để chạy code python.
Bạn truy cập link: https://www.python.org/downloads/release/python-3107/
Tải và cài đặt Python 3.10.7 hoặc mới hơn cho Windows.
Sau khi đã cài đặt bạn kiểm tra bằng cách mở CMD, gõ lệnh: python –V. Để kiểm tra version python đã cài đặt.
Ngoài ra để tiện cho việc kiểm tra các kết quả xuất ra sau khi chạy lệnh call API bạn cần cài đặt thêm một tool chỉnh sửa code như Visual Studio Code.
Bạn truy cập link: https://code.visualstudio.com/download
Tải và cài đặt.
Giao diện Visual Studio Code sau khi cài đặt.
Bước 3: GET các thông số để call Endpoint API
Bạn có thể truy cập vào link để lấy các file code Python được sử dụng trong các bước bên dưới:
Link: https://drive.google.com/drive/u/0/folders/1jAVanOogWjC4bQuCVebrZqW0jeGAfMV_
Các thông tin cần có để có thể chạy các lệnh call Endpoint API bao gồm:
- Access Token
- Tenant ID
- Data Region
Trong đó:
- Tenant: Một “tenant” sẽ là tập hợp các tài nguyên như devices, events, policies được quản lý bởi một tổ chức.
- Data regions: Lưu giữ tất cả dữ liệu cho một tenant nằm trong một vùng dữ liệu duy nhất.
- Access Token: Là 1 đoạn mã dùng để xác thực khi bạn thực hiện các API call với Tenant ID.
Bước 3.1: Tạo file API_CREDENTIAL
Bạn mở Visual Studio Code tạo 1 file với tên “API_CREDENTIAL.json” lưu với đuôi file .json
Tiếp theo bạn sẽ input thông số Client ID và Client Secret đã lấy ở “Bước 1” như hình dưới.
Mình đã custom một file code Python để lấy các thông tin về Access Token, Tenant ID và Data Region cùng lúc dựa vào thông số Client ID và Client Secret bạn đã cung cấp. Bạn không cần chỉnh sửa file này, chỉ cần mở CMD và chạy file.
File code Python lưu với tên “GET_INFO.py” có dạng như hình dưới:
Bước 3.2: Chạy lệnh “GET_INFO.py” trên CMD
Note: Bạn cần lưu file “API_CREDENTIAL.json” và “GET_INFO.py” chung 1 folder.
Tiếp theo bạn mở CMD trên endpoint. Bạn cần đi đến folder chứa code “GET_INFO.py” như sau.
Ví dụ: Đường dẫn bạn lưu trong “Desktop/API/GET_INFO.py”.
Chạy lệnh “cd Desktop/API”: Vào thư mục API có chứa file GET_INFO.py
Chạy lệnh “python GET_INFO.py”: Thực thi lệnh để lấy các thông tin. Nhấn Enter.
Kết quả trong folder API sẽ xuất hiện 1 file “GET_INFO.json”.
Bước 3.3: Kiểm tra thông tin.
Bạn mở file GET_INFO.json với phần mềm Visual Studio Code. Để dễ kiểm tra kết quả bạn click chuột phải chọn “Format Document” để thay đổi định dạng sang dòng lệnh.
Kết quả đã lấy được các thông tin về Access Token, Tenant ID và Data Region trên Sophos Endpoint API của bạn.
