Tài liệu nhà phát triểnBản Markdownopenapi.jsonllms.txt

Tham chiếu: Shop

Thông tin shop mà khoá API đang thuộc về. Mọi đường dẫn dưới https://danix.vn/api/open/v1. Đặc tả máy đọc: openapi.json.

Thông tin shop của khoá

GET /shop

Trả shop mà khoá API thuộc về, tên ứng dụng kết nối, các quyền được cấp, các trang chat được dùng và cờ chỉ đọc. Đây là cách nhanh nhất để kiểm khoá hoạt động.

Quyền cần có: không cần quyền nào ngoài khoá hợp lệ.

Ví dụ yêu cầu

curl -X GET "https://danix.vn/api/open/v1/shop" \
  -H "Authorization: Bearer dnx_live_…"

Phản hồi mẫu (200)

{
  "id": "018f3b8e-0000-7000-8000-00000000a001",
  "slug": "shop-mau",
  "name": "Shop Mẫu",
  "application": {
    "name": "Đồng bộ kế toán",
    "permissions": [
      "pos.orders.read"
    ],
    "pageIds": []
  },
  "readOnly": false
}

Trường của phản hồi

Trường Kiểu Bắt buộc Mô tả
id string (uuid) có Mã định danh của shop.
slug string có Tên ngắn của shop trong đường dẫn.
name string có Tên shop.
application object có Thông tin ứng dụng kết nối gắn với khoá.
application.name string có Tên ứng dụng kết nối đang gọi.
application.permissions array<string> có Các quyền khoá này được cấp, ví dụ pos.orders.read.
application.pageIds array<string (uuid)> có Mã (UUID) trong DANIX của các trang chat khoá này được dùng — cùng giá trị id của GET /pages. Rỗng nếu khoá không có quyền chat.
readOnly boolean có true khi gói cước hết hạn: khoá chỉ đọc, ghi trả 402.

Lỗi

Trạng thái Mã code Ý nghĩa
401 invalid-api-key Khoá API thiếu, sai hoặc đã bị thu hồi
403 insufficient-permission Khoá API không có quyền thực hiện thao tác này
403 shop-suspended Shop đang bị đình chỉ
403 automation-not-active Shop chưa bật tính năng Tự động hoá
429 rate-limited Vượt hạn mức gọi API, hãy chờ rồi thử lại
500 internal-error Lỗi hệ thống

Định dạng lỗi và bảng mọi mã code: Lỗi.