Tài liệu API Multilogin có ba khu vực chính: sử dụng thanh bên trái để tìm các nhóm endpoint, mở một endpoint để xem phương thức, tham số, nội dung yêu cầu và ví dụ phản hồi, đồng thời dùng thanh trên cùng để thay đổi cách hiển thị tài liệu hoặc mở bộ sưu tập trong Postman.

Hướng dẫn này giải thích chức năng của từng khu vực và nơi tìm thông tin khi tạo hoặc kiểm tra yêu cầu API.

Thanh hỗ trợ bên trái: Thư viện Endpoints

Thanh hỗ trợ bên trái là nơi bạn bắt đầu. Tất cả các Endpoint được nhóm vào các thư mục, dựa trên các tiện ích, chẳng hạn như:

• Launcher: bắt đầu và dừng các cấu hình trình duyệt bình thường và nhanh, lấy siêu dữ liệu cấu hình và các công cụ khác,
• Profile Access Management: quản lý những ai có thể truy cập hồ sơ, thư mục và mã thông báo API của bạn
• Profile Management: tạo, tìm kiếm, xóa, cập nhật và nhiều chức năng khác
• Browser Profile Data: công cụ quản lý dữ liệu trên hồ sơ trình duyệt của bạn và đảm bảo luồng thông suốt
• Proxy: tạo proxy mới và quản lý các cấu hình trình duyệt hiện có
• Pre-made Cookies: tạo hoặc quản lý dữ liệu cookie cho các quy trình hồ sơ trình duyệt được hỗ trợ
• Script Runner: chạy các tập lệnh tự động hóa với kiến thức tối thiểu
• Profile Import/Export: cho phép xuất và nhập hồ sơ từ máy
• Object Storage: cho phép tải lên và tải xuống tệp từ bộ nhớ trong
• Bookmark Management: cung cấp các tùy chọn sao chép, nhập và xuất dấu trang giữa các hồ sơ trình duyệt
• 2FA: bật xác thực hai yếu tố để có thêm một lớp bảo mật

Tổng quan về Endpoint

Mỗi Endpoint cung cấp cho bạn bản phân tích đầy đủ về cách thực hiện yêu cầu – không cần phải tự suy đoán. Sau đây là những gì bạn sẽ tìm thấy khi nhấp vào một Endpoint:

• Kiểu phương thức: Yêu cầu GET, POST, PUT hoặc DELETE – giúp bạn biết hành động nào nó thực hiện
• Đường dẫn: đường dẫn URL cụ thể được sử dụng để truy cập Endpoint đó
• Các thông số:
  • Headers: thông tin như Token xác thực của bạn
  • Query params: các tiện ích bổ sung tùy chọn để dán vào URL
  • Path variables: các phần có thể hoán đổi của URL
• Ví dụ về yêu cầu ở Body: hiển thị chính xác những gì bạn cần đưa vào yêu cầu POST/PUT của mình
• Ví dụ về lựa chọn JSON ở Body: một bản mẫu để hiển thị những gì mong đợi từ kết quả

Các Endpoint giống như các thẻ hướng dẫn: mỗi thẻ cho bạn biết chính xác thông tin nào cần gửi và thông tin nào bạn sẽ nhận lại. Cho dù bạn chỉ sao chép JSON mẫu hay điều chỉnh Header, điều này giúp bạn tránh gặp lỗi.

Ví dụ về yêu cầu và phản hồi

Ở phía dưới hoặc phần bên phải của hầu hết các Endpoint, bạn sẽ thấy Ví dụ về Yêu cầu (Request) và Ví dụ về Phản hồi (Response), có thể được sử dụng để tránh việc tự viết Code từ đầu.

• Chúng đóng vai trò như các khuông mẫu: chỉ việc sao chép và dán trực tiếp vào Postman!
• Đặc biệt hữu ích khi xây dựng các chuỗi trình tự hoặc gỡ lỗi
• Bạn có thể thay đổi ngôn ngữ mã hóa từ thanh công cụ trên cùng
• Nội dung phản hồi sẽ tự động xuất hiện trong JSON

Thanh công cụ trên cùng: các lựa chọn về kiểu hiển thị

Thanh trên cùng cho phép bạn điều chỉnh phong cách hiển thị ưa thích của mình.

Layout Menu cho phép chọn cách sắp xếp nội dung của trang:

• Single Column: cả nội dung điểm cuối và yêu cầu ví dụ đều được hiển thị theo chiều dọc
• Double Column: nội dung điểm cuối nằm ở giữa; ví dụ yêu cầu và phản hồi nằm ở bên phải

Language Menu – thay đổi ngôn ngữ dùng cho các ví dụ mã được tạo, chẳng hạn như cURL hoặc một định dạng được hỗ trợ khác.

Tại biểu tượng Engine bên phải, bạn có thể chỉnh sửa các tiêu chí cụ thể từ ngôn ngữ bạn muốn:

• Các yêu cầu sẽ được hiển thị như thế nào trong ngôn ngữ lập trình của bạn:
  • Thiết lập số lượng và kiểu thụt lề
  • Cắt tỉa và “làm đẹp” các chi tiết không cần thiết
• Về mặt kỹ thuật, các yêu cầu sẽ hoạt động như thế nào:
  • Chọn giới hạn thời gian chờ yêu cầu
  • Kích hoạt chuyển hướng theo HTTP

Thanh công cụ trên cùng: Running in Postman

Ở phía bên phải của Thanh công cụ trên cùng, bạn sẽ tìm thấy biểu tượng Run in Postman.

1. Nhấp vào “Run in Postman” → bạn sẽ có thể kết xuất các Endpoint một cách trực tiếp
2. Tải xuống và cài đặt Postman
3. Nhấp vào “Postman cho <hệ điều hành của bạn>” (khuyến nghị)
4. Trong “Import Collection” → chọn thư mục để nhập bộ sưu tập API Multilogin
5. Nhấp vào “Import”

Thiết lập môi trường cục bộ cho Postman của bạn

Bạn đã thêm bộ sưu tập Endpoints vào Postman chưa ? Nó sẽ trông như thế này, cũng giống như bộ tài liệu API, nhưng giờ được lưu trữ trực tiếp vào không gian làm việc cục bộ của bạn!

Khắc phục sự cố

Không tìm thấy endpoint?

Kiểm tra nhóm endpoint trong thanh bên trái và xem phần tổng quan của bộ sưu tập. Các phiên bản endpoint cũ có thể đã ngừng được hỗ trợ hoặc được chuyển sang vị trí khác.

Bộ sưu tập đã nhập trông khác với tài liệu?

Nhập lại bộ sưu tập API Multilogin hiện tại và kiểm tra xem bạn có đang xem phiên bản endpoint mới nhất hay không.