Skip to main content

Lấy thông tin gian hàng

API này trả về gian hàng sở hữu API key bạn đang dùng. Thường gọi ngay khi người dùng nhập API key để:

  • Kiểm tra API key còn hiệu lực.
  • Lấy id gian hàng để ghép với dữ liệu khác, ví dụ shopId trong webhook.
Mỗi API key thuộc một gian hàng

Hai API key khác nhau của cùng một gian hàng luôn trả về cùng data.id.

Endpoint​

🔗Endpoint Staging
GET https://staging-manage.api.miniai.vn/api/external/v1/shop
🔗Endpoint Production
GET https://manage-api.miniap.vn/api/external/v1/shop

Xác thực (Authentication)​

Mọi request phải gửi kèm API key của bạn trong header:

HeaderGiá trịYêu cầu
x-api-keyminiai-partner <API_KEY_CỦA_BẠN>Bắt buộc

Tham số truy vấn (Query Parameters)​

API này không có tham số. Gian hàng được xác định hoàn toàn từ API key.

Ví dụ Request​

curl -X GET 'https://staging-manage.api.miniai.vn/api/external/v1/shop' \
  -H 'x-api-key: miniai-partner <API_KEY_CỦA_BẠN>'

Phản hồi (Response)​

Thành công trả về mã 200.

{
    "success": true,
    "data": {
        "id": "64204a17a5a97a86f12e1f0a",
        "name": "Mena Official"
    }
}

Các trường trong data​

TrườngKiểuMô tả
idstringID gian hàng sở hữu API key
namestringTên gian hàng, dùng để hiển thị cho người dùng

Lỗi thường gặp​

MãNguyên nhân
401Thiếu header x-api-key, sai tiền tố miniai-partner , hoặc API key không hợp lệ / đã bị xoá
429Vượt giới hạn số request (xem mục Giới hạn bên dưới)
500Lỗi hệ thống

Phản hồi là chuỗi văn bản thuần (không phải JSON):

Unauthorized
Dùng mã 401 để kiểm tra key

Nhận 200 nghĩa là API key hợp lệ. Nhận 401 nghĩa là key sai hoặc đã bị thu hồi.

Giới hạn (Rate limit)​

100 request / phút

Mỗi gian hàng được gọi tối đa 100 request mỗi phút trên toàn bộ External API. Vượt quá giới hạn sẽ nhận mã 429.

Các bước tiếp theo​