Cổng dữ liệu HV Holdings

Cách gọi

GET /v1/data/<id>?<params> with header "Authorization: Bearer <access_token>" (token from the shared login id.hvholdings.vn). Every registered app may call every API; each user only sees data their own HV Admin account is allowed to see.

Khi gặp lỗi

Lỗi luôn có dạng { "error": "…", "code": "…" }. Mọi app đã đăng ký đều gọi được mọi API. Columns not listed for an API may appear when the source adds new fields — ignore unknown columns.

Tài khoản profilephiên bản 1nguồn HV Admin

Thông tin tài khoản HV Admin của chính người đang đăng nhập: mã, tên đăng nhập, họ tên, email, số điện thoại, ảnh, tình trạng. Luôn trả 1 dòng — không xem được tài khoản người khác.

GET https://api.hvholdings.vn/v1/data/profile
Authorization: Bearer <access_token>

Tham số

Không có.

Cột trả về (trong rows)

Mẫu trả về

{
  "api": "profile",
  "version": 1,
  "page": 1,
  "has_more": false,
  "count": 1,
  "rows": [
    {
      "id": "string",
      "userName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "isActive": "boolean",
      "emailConfirmed": "boolean",
      "phoneNumber": "string",
      "imageUrl": "string",
      "twoFactorEnabled": "boolean"
    }
  ]
}

Thị trường marketsphiên bản 1nguồn HV Admin

Các thị trường (nước bán) mà tài khoản đang đăng nhập được kinh doanh. HV Admin tự lọc theo tài khoản — mỗi người thấy danh sách của mình. Dùng làm ô chọn thị trường và làm mã thị trường khi gọi các API khác.

GET https://api.hvholdings.vn/v1/data/markets
Authorization: Bearer <access_token>

Tham số

Cột trả về (trong rows)

Mẫu trả về

{
  "api": "markets",
  "version": 1,
  "page": 1,
  "has_more": false,
  "count": 1,
  "rows": [
    {
      "value": "string",
      "label": "string",
      "hint": "string",
      "parentValue": "string"
    }
  ]
}

Doanh số marketing marketing-performancephiên bản 1nguồn HV Admin

Doanh số, chi phí marketing, giá vốn, lợi nhuận và tình trạng đơn theo từng nhân sự marketing × thị trường trong 1 khoảng ngày. HV Admin tự lọc theo tài khoản — mỗi người thấy phần mình được xem. Số tiền theo đơn vị ở tham số currency.

GET https://api.hvholdings.vn/v1/data/marketing-performance
Authorization: Bearer <access_token>

Tham số

Cột trả về (trong rows)

Mẫu trả về

{
  "api": "marketing-performance",
  "version": 1,
  "page": 1,
  "has_more": false,
  "count": 1,
  "rows": [
    {
      "marketerEmployeeId": "string",
      "marketerName": "string",
      "marketId": "string",
      "marketName": "string",
      "orgUnitCode": "string",
      "structurePath": "string",
      "orderCount": "number",
      "confirmedOrders": "number",
      "actualRevenue": "number",
      "gmvAfterDiscount": "number",
      "revenue": "number",
      "totalMarketingCost": "number",
      "partnerFee": "number",
      "partnerFeeRatioOnGmvAfterDiscount": "number",
      "partnerFeeRatioOnRevenue": "number",
      "productCogs": "number",
      "productCogsRatioOnGmvAfterDiscount": "number",
      "productCogsRatioOnRevenue": "number",
      "productCogsRatioOnCogs": "number",
      "giftCogs": "number",
      "giftCogsRatioOnGmvAfterDiscount": "number",
      "giftCogsRatioOnRevenue": "number",
      "giftCogsRatioOnCogs": "number",
      "cogs": "number",
      "cogsRatioOnGmvAfterDiscount": "number",
      "cogsRatioOnRevenue": "number",
      "expectedProfit": "number",
      "expectedProfitRatioOnGmvAfterDiscount": "number",
      "expectedProfitRatioOnRevenue": "number",
      "netProfit": "number",
      "netProfitRatioOnGmvAfterDiscount": "number",
      "netProfitRatioOnRevenue": "number",
      "performance": "number",
      "marketingCostRatioOnGmvAfterDiscount": "number",
      "marketingCostRatioOnRevenue": "number",
      "roasOnGmvAfterDiscount": "number",
      "roasOnRevenue": "number",
      "roasOffPlatform": "number",
      "confirmedAov": "number",
      "confirmedAovOnRevenue": "number",
      "totalOrders": "number",
      "processing": "number",
      "confirmed": "number",
      "cancelled": "number",
      "waitingShipment": "number",
      "shipping": "number",
      "delivered": "number",
      "returned": "number",
      "cancelledAfterFinalized": "number",
      "productCount": "number"
    }
  ]
}