hddt.dev
Tài liệuBảng giáTra cứu

Bắt đầu

  • Tổng quan
  • Bắt đầu nhanh
  • Xác thực
  • Môi trường sandbox
  • Mã lỗi

Ứng dụng

  • GETThông tin ứng dụng
  • PATCHCập nhật ứng dụng

Hoá đơn

  • POSTLấy token
  • GETLấy mẫu hoá đơn
  • GETDanh sách mẫu đã đăng ký
  • GETHạn mức hoá đơn
  • POSTTạo mẫu hoá đơn
  • POSTDuyệt số lượng hoá đơn
  • DELETEXoá mẫu chưa duyệt
  • POSTTạo hoá đơn
  • GETDanh sách hoá đơn
  • POSTKý hoá đơn nháp
  • GETTải hoá đơn PDF/XML
  • DELETEXoá hoá đơn nháp

Tra cứu

  • GETTra cứu mã số thuế

Webhook

  • GETDanh sách webhook
  • POSTThêm webhook
  • POSTNhận và kiểm tra
Trang chủTài liệuThông tin ứng dụng
GET/v1/apps/{app_id}

Thông tin ứng dụng

Đọc hồ sơ ứng dụng đã tạo trong trang quản trị: tên, trạng thái, mã số thuế và hạn mức của môi trường gắn với API key.

MarkdownOpenAPI

#Giới thiệu

API này trả thông tin một ứng dụng bạn đã tạo trong trang quản trị. Dùng khi cần đối chiếu App ID, tên đơn vị, trạng thái hoạt động hoặc số hoá đơn còn lại trước khi phát hành.

Xác thực bằng API key trong header api_key. Key quyết định môi trường được trả về: key hddt_test_ đọc sandbox, key Live đọc production. Endpoint không dùng token hoá đơn và không trừ hạn mức phát hành.

#Endpoint

Gửi GET với App ID trên đường dẫn. Host phải cùng môi trường với API key. Sandbox: https://sandbox.api.hddt.dev. Live: https://api.hddt.dev.

API key phải thuộc đúng ứng dụng có app_id đó. Phản hồi không chứa API key, bí mật webhook hay danh sách IP cho phép.

Một key, một môi trường

Mỗi API key chỉ đọc được sổ hạn mức của môi trường nó thuộc về. Muốn xem cả sandbox và Live thì gọi hai lần, mỗi lần một key.

#Header

api_keystringBắt buộc

API key của ứng dụng.

#Param

Nằm trên đường dẫn.

app_idstringBắt buộc

Định danh ứng dụng (UUID) sao chép từ trang quản trị. Ví dụ f47ac10b-58cc-4372-a567-0e02b2c3d479.

#Ví dụ

Request mẫu trên sandbox. Thay App ID và API key bằng giá trị của ứng dụng bạn.

cURL
curl https://sandbox.api.hddt.dev/v1/apps/f47ac10b-58cc-4372-a567-0e02b2c3d479 \
  -H "api_key: $HDDT_API_KEY"

#Phản hồi

Khi key hợp lệ và khớp ứng dụng, API trả 200 OK. Trường environment là sandbox hoặc live, đúng với key vừa dùng.

idstringBắt buộc

App ID, trùng giá trị trên đường dẫn.

objectstringBắt buộc

Luôn là app.

namestringBắt buộc

Tên ứng dụng trong trang quản trị.

descriptionstringBắt buộc

Mô tả ngắn. Chuỗi rỗng nếu chưa nhập.

statusstringBắt buộc

active khi ứng dụng đang chạy, paused khi đang tạm dừng.

tax_codestringTuỳ chọn

Mã số thuế đơn vị phát hành. null nếu chưa khai báo.

company_namestringTuỳ chọn

Tên đơn vị phát hành. null nếu chưa khai báo.

environmentstringBắt buộc

sandbox hoặc live, theo API key của request.

base_urlstringBắt buộc

Host gốc của môi trường đó, gồm tiền tố /v1.

rate_limitintegerBắt buộc

Số request tối đa mỗi phút của môi trường này.

created_atstringBắt buộc

Thời điểm tạo ứng dụng, ISO 8601, múi giờ +07:00.

200 OK
{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "object": "app",
  "name": "Shop ABC",
  "description": "Website bán hàng, xuất hoá đơn tự động khi đơn hàng hoàn tất.",
  "status": "active",
  "tax_code": "0312345678",
  "company_name": "Công ty TNHH Thương mại ABC",
  "environment": "sandbox",
  "base_url": "https://sandbox.api.hddt.dev/v1",
  "rate_limit": 30,
  "quota": {
    "invoices_used": 342,
    "invoices_remaining": 658
  },
  "created_at": "2026-03-12T09:00:00+07:00"
}

#Hạn mức

Object quota theo môi trường của API key. Đây là tổng số hoá đơn được dùng, không làm mới theo tháng.

invoices_usedintegerBắt buộc

Tổng số hoá đơn đã phát hành trong môi trường này.

invoices_remainingintegerBắt buộc

Tổng số hoá đơn còn lại của môi trường. Không làm mới theo tháng. Khi về 0, API phát hành trả 402.

#Mã lỗi

Các trường hợp thường gặp khi đọc thông tin ứng dụng:

401 unauthorized—Tuỳ chọn

Thiếu header api_key, API key sai hoặc đã bị thu hồi.

403 forbidden—Tuỳ chọn

API key không thuộc app_id này, hoặc gửi key của môi trường khác (key hddt_live_ tới host Sandbox, key hddt_test_ tới host Live).

404 not_found—Tuỳ chọn

Không có ứng dụng nào khớp app_id.

422 validation_error—Tuỳ chọn

app_id không phải UUID.

Trước đóMã lỗiTiếp theoCập nhật ứng dụng
Trang này có hữu ích không?
Cập nhật lần cuối: 27/10/2026

Trên trang này

  • Giới thiệu
  • Endpoint
  • Header
  • Param
  • Ví dụ
  • Phản hồi
  • Hạn mức
  • Mã lỗi
Đăng nhậpBắt đầu ngay