Cấu hình 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
| Property | Type | Required | Description |
|---|---|---|---|
| miniAppId | String | true | ID của Mini App tương ứng |
| domain | String | true | Domain 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 |
| status | String | true | Trạng thái của API domain, có thể là 'ACTIVE' hoặc 'INACTIVE' |
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| id | int | Id của API Domain vừa được thêm vào |
| domain | String | Domain đã được thêm vào |
| status | String | Trạng thái của API Domain |
| lastUpdated | Long | Thời gian cập nhật cuối cùng của API Domain |
Sample Code
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.request.CreateApiDomainRequest;
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.response.CreateApiDomainResponse;
CreateApiDomainRequest request = new CreateApiDomainRequest();
request.setMiniAppId("your_mini_app_id");
request.setDomain("your_api_domain");
request.setStatus("ACTIVE");
CreateApiDomainResponse response = client.createApiDomain(request);
2. Lấy danh sách API Domain
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
| miniAppId | String | true | ID của Mini App tương ứng |
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| apiDomains | List ApiDomain | Danh sách API Domain của Mini App |
ApiDomain
| Property | Type | Description |
|---|---|---|
| id | int | Id |
| domain | String | API Domain |
| status | String | 'ACTIVE', 'INACTIVE' |
| lastUpdated | Long | Thời gian cập nhật cuối cùng của API Domain |
Sample Code
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.request.ListApiDomainRequest;
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.response.ListApiDomainResponse;
ListApiDomainRequest request = new ListApiDomainRequest();
request.setMiniAppId("your_mini_app_id");
ListApiDomainResponse response = client.listAPIDomain(request);
3. Cập nhật API Domain
Parameters
| Property | Type | Required | Description |
|---|---|---|---|
| miniAppId | long | true | ID của Mini App tương ứng |
| id | int | true | ID của API domain cần cập nhật |
| status | String | true | Trạng thái của API domain, có thể là 'ACTIVE' hoặc 'INACTIVE' |
Return Values
| Property | Type | Description |
|---|---|---|
| error | int | Mã lỗi của kết quả trả về, bằng 0 nếu request thành công |
| message | String | Lời nhắn chi tiết tương ứng với mã lỗi |
| domain | String | Domain hiện tại |
| status | String | Trạng thái của API domain |
| lastUpdated | Long | Thời gian cập nhật cuối cùng của API Domain |
Sample Code
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.request.UpdateApiDomainRequest;
import com.vng.zalo.miniapp.openapi.sdk.models.apidomain.response.UpdateApiDomainResponse;
UpdateApiDomainRequest updateRequest = new UpdateApiDomainRequest();
updateRequest.setMiniAppId("your_mini_app_id");
updateRequest.setId("your_api_domain_id");
updateRequest.setStatus("INACTIVE");
UpdateApiDomainResponse updateResponse = client.updateApiDomain(updateRequest);