Để bắt đầu sử dụng Apidog trong tổ chức của bạn, bạn có thể thực hiện các tác vụ sau nhằm thiết lập đội nhóm Apidog của mình để đạt hiệu quả. Khuyến nghị bạn trước tiên nên phối hợp với Quản trị viên đội nhóm và đội ngũ IT của tổ chức để thiết lập, bảo mật và quản lý Apidog trong tổ chức. Sau đó, bạn có thể thiết lập đội nhóm Apidog bằng cách cấu hình các cài đặt liên quan, mời mọi người vào đội nhóm và gán vai trò cho họ, cũng như tạo các tài nguyên liên quan đến dự án của bạn.Bạn có thể tải xuống và cài đặt ứng dụng Apidog dành cho máy tính để bàn trên Windows, Mac và Linux. Bạn cũng có thể truy cập Apidog trên web bằng Apidog Agent.
Hãy liên hệ với đội ngũ IT của bạn để thiết lập quy trình thêm một phần mềm mới, quy trình này có thể khác nhau giữa các tổ chức. Các chủ đề sau đây là phổ biến:
Đội ngũ IT của bạn có thể cần thêm một ngoại lệ vào chính sách thiết bị để cho phép cài đặt Apidog trên máy trạm của nhân viên. Cung cấp liên kết tải xuống Apidog cho đội ngũ IT để hỗ trợ thiết lập ngoại lệ này.
Nếu kết nối mạng của tổ chức bạn nằm sau proxy, bạn có thể cần cấu hình Apidog cho phù hợp. Hãy lấy thông tin chi tiết về kết nối proxy từ đội ngũ IT của bạn và thiết lập chúng trong Apidog.
INFO
Nếu bạn đã đăng nhập vào Apidog, bạn có thể thiết lập proxy bằng cách điều hướng đến tùy chọn ⚙Settings → Proxy nằm ở góc trên bên phải của giao diện Apidog. Ngoài ra, nếu bạn chưa đăng nhập vào Apidog, bạn có thể cấu hình cài đặt proxy ở góc dưới bên trái của màn hình đăng nhập trong ứng dụng khách Apidog.
Nếu tổ chức của bạn hoạt động phía sau tường lửa, đội ngũ IT của bạn có thể cần cấu hình danh sách cho phép cho các miền của Apidog. Điều này đảm bảo dữ liệu Apidog được đồng bộ hóa với đám mây và mọi chức năng hoạt động như mong đợi.
Trước tiên, bạn cần quyết định thành viên nào trong tổ chức của mình sẽ là Quản trị viên đội nhóm. Quản trị viên đội nhóm có thể đăng ký tài khoản Apidog, tạo một đội nhóm mới, và tự động trở thành Chủ sở hữu đội nhóm của đội nhóm mới này.Chủ sở hữu đội nhóm có các quyền sau:
Sửa đổi thông tin đội nhóm
Tạo dự án mới
Mời và xóa thành viên
Thiết lập quyền đội nhóm và quyền dự án cho các thành viên khác
Quản lý đăng ký và thanh toán
Chuyển nhượng và giải thể đội nhóm
Một đội nhóm có thể bao gồm nhiều thành viên và quản lý nhiều dự án khác nhau. Quản trị viên có thẩm quyền xác định thành viên nào có quyền nào trong các dự án cụ thể.Trong phiên bản miễn phí của Apidog, một đội nhóm có thể có tối đa 4 thành viên. Nếu đội nhóm của bạn vượt quá 4 thành viên, bạn sẽ cần nâng cấp lên gói trả phí của Apidog.
Chủ sở hữu đội nhóm có thể mời một vài thành viên khác làm quản trị viên đội nhóm, những người sau đó sẽ chịu trách nhiệm mời và quản lý thêm các thành viên cộng tác trong đội nhóm.Quản trị viên đội nhóm có thể mời các thành viên khác tham gia đội nhóm qua email hoặc liên kết mời. Khi mời thành viên tham gia, họ có thể thiết lập quyền mặc định cho các thành viên đối với các dự án trong đội nhóm. Những quyền này thường bao gồm Admin, Editor, Read-only và Forbidden.Điều quan trọng cần lưu ý là trong Apidog, Quyền đội nhóm và Quyền dự án là các cấp độ ủy quyền riêng biệt. Quyền đội nhóm được sử dụng để quản lý toàn bộ đội nhóm, bao gồm cài đặt đội nhóm, quản lý thành viên và quản trị tổng thể đội nhóm. Quyền đội nhóm bao gồm các vai trò như Team owner, Team Admin, Team member và Guest.Mặt khác, Quyền dự án được tùy chỉnh riêng để quản lý từng dự án trong đội nhóm. Những quyền này chi phối các khía cạnh liên quan đến cài đặt dự án, kiểm soát truy cập và cộng tác trong phạm vi dự án. Quyền dự án bao gồm các vai trò như Admin, Editor, Read-only hoặc Forbidden, quyết định mức độ kiểm soát và truy cập mà thành viên đội nhóm có trong một dự án cụ thể.
Chủ sở hữu đội nhóm và quản trị viên đội nhóm có thể tạo dự án mới trong đội nhóm. Khi tạo dự án, bạn có thể chỉ định tên và mô tả dự án, đồng thời chọn mẫu dự án phù hợp dựa trên nhu cầu của mình.Sau khi tạo dự án, bạn có thể mời thành viên đội nhóm tham gia dự án và gán cho họ quyền dự án phù hợp. Điều này cho phép các thành viên đội nhóm cộng tác trong dự án và truy cập tài nguyên dự án dựa trên quyền được gán của họ.
Nếu bạn đang di chuyển từ một công cụ quản lý API khác sang Apidog, bạn có thể nhập dữ liệu API hiện có của mình vào Apidog. Apidog hỗ trợ nhập dữ liệu từ nhiều định dạng khác nhau, bao gồm OpenAPI/Swagger, Postman và nhiều định dạng khác.Để nhập dữ liệu, hãy điều hướng đến cài đặt dự án và chọn tùy chọn Import Data. Chọn định dạng nhập phù hợp và làm theo hướng dẫn trên màn hình để hoàn tất quá trình nhập.
Sau khi thiết lập đội nhóm và tạo dự án, bạn có thể cấu hình các cài đặt ban đầu để tùy chỉnh Apidog theo nhu cầu của tổ chức. Điều này bao gồm:
Cài đặt đội nhóm: Cấu hình các cài đặt ở cấp đội nhóm như tên đội nhóm, mô tả và ảnh đại diện.
Cài đặt dự án: Cấu hình các cài đặt ở cấp dự án như tên dự án, mô tả và môi trường mặc định.
Biến môi trường: Thiết lập biến môi trường để quản lý các môi trường khác nhau (ví dụ: phát triển, staging, production).
Cài đặt thông báo: Cấu hình cài đặt thông báo để nhận cảnh báo về các sự kiện quan trọng.
Bằng cách làm theo các bước này, bạn có thể thiết lập Apidog trong tổ chức của mình và bắt đầu cộng tác với đội nhóm về thiết kế, phát triển và tài liệu API.
