Chuyển tới nội dung chính

Thêm API Domain

Tính năng Quản lý API Domain cho phép đối tác khai báo danh sách các domain mà Mini App sử dụng để gửi yêu cầu (request). Dựa trên thông tin này, Mini App Platform hỗ trợ theo dõi và thống kê các chỉ số quan trọng như hiệu suất, lỗi và các vấn đề phát sinh trong quá trình giao tiếp, giúp đối tác chủ động kiểm soát, nhanh chóng phát hiện sự cố và tối ưu hóa chất lượng hoạt động của Mini App.

1. Thêm API Domain

Hàm này dùng để thêm mới một API Domain vào Mini App, và không được thêm trùng với các domain đã được thêm trước đó.

Parameters

PropertyTypeRequiredDescription
miniAppIdStringtrueID của Mini App tương ứng
domainStringtrueDomain phải bắt đầu bằng https:// và không chứa bất kỳ sub-path hay parameters nào. Ví dụ: https://yourdomain.com
statusStringtrueTrạng thái của API domain, có thể là 'ACTIVE' hoặc 'INACTIVE'

Return Values

PropertyTypeDescription
errorintMã lỗi của kết quả trả về, bằng 0 nếu request thành công
messageStringLời nhắn chi tiết tương ứng với mã lỗi
idintId của API Domain vừa được thêm vào
domainStringDomain đã được thêm vào
statusStringTrạng thái của API Domain
lastUpdatedLongThời gian cập nhật cuối cùng của API Domain

Sample Code

Code demo fallback when rendering server side!

2. Lấy danh sách API Domain

Parameters

PropertyTypeRequiredDescription
miniAppIdStringtrueID của Mini App tương ứng

Return Values

PropertyTypeDescription
errorintMã lỗi của kết quả trả về, bằng 0 nếu request thành công
messageStringLời nhắn chi tiết tương ứng với mã lỗi
apiDomainsList ApiDomainDanh sách API Domain của Mini App

ApiDomain

PropertyTypeDescription
idintId
domainStringAPI Domain
statusString'ACTIVE', 'INACTIVE'
lastUpdatedLongThời gian cập nhật cuối cùng của API Domain

Sample Code

Code demo fallback when rendering server side!

3. Cập nhật API Domain

Parameters

PropertyTypeRequiredDescription
miniAppIdlongtrueID của Mini App tương ứng
idinttrueID của API domain cần cập nhật
statusStringtrueTrạng thái của API domain, có thể là 'ACTIVE' hoặc 'INACTIVE'

Return Values

PropertyTypeDescription
errorintMã lỗi của kết quả trả về, bằng 0 nếu request thành công
messageStringLời nhắn chi tiết tương ứng với mã lỗi
domainStringDomain hiện tại
statusStringTrạng thái của API domain
lastUpdatedLongThời gian cập nhật cuối cùng của API Domain

Sample Code

Code demo fallback when rendering server side!