Thuật ngữ chuẩn

Bảng thuật ngữ chuẩn của HiTechCloud Developers: endpoint, webhook, xác thực, khoá API, access token, giới hạn tần suất, phân trang, chữ ký, sandbox và giao dịch.

Xem Markdown

Tài liệu HiTechCloud dùng một bộ thuật ngữ thống nhất cho mọi sản phẩm. Một số từ tiếng Anh đã phổ biến với lập trình viên thì giữ nguyên (vd endpoint, webhook, token); phần còn lại dùng thuật ngữ tiếng Việt chuẩn dưới đây.

Giao thức & Yêu cầu

Thuật ngữTiếng AnhQuy ước dùng
endpointendpointGiữ nguyên endpoint — một đường dẫn API cụ thể (vd GET /v1/orders).
yêu cầurequestyêu cầu cho request; phản hồi cho response.
phản hồiresponseNội dung máy chủ trả về.
tham số đường dẫnpath parameterBiến trong đường dẫn, vd {id}.
tham số truy vấnquery parameterTham số sau dấu ?, vd ?page=2.
thân yêu cầurequest bodyDữ liệu gửi kèm (thường JSON).
headerheaderGiữ nguyên header.
khung phản hồiresponse envelopeCấu trúc bọc ngoài: status / data / meta.
phân trangpaginationpage / per_page và meta.pagination.
giới hạn tần suấtrate limitSố yêu cầu tối đa trong một khoảng thời gian.
idempotencyidempotencyTính bất biến khi lặp — gửi lại cùng yêu cầu không tạo thêm bản ghi.

Xác thực & Bảo mật

Thuật ngữTiếng AnhQuy ước dùng
xác thựcauthenticationXác minh danh tính (đăng nhập, khoá API).
phân quyềnauthorizationCấp quyền truy cập tài nguyên.
khoá APIAPI keykhoá API — gửi qua header X-API-Key.
access tokenaccess tokenToken truy cập, gửi qua Authorization: Bearer ....
phạm viscopephạm vi (scope) — quyền giới hạn của một khoá/token.
chữ kýsignatureChữ ký HMAC/JWS để xác minh webhook hoặc yêu cầu.
webhookwebhookGiữ nguyên webhook — HiTechCloud gọi ngược về URL của bạn.
callbackcallbackURL nhận kết quả sau một hành động.
danh sách IP cho phépIP allowlistGiới hạn IP được gọi API.

Môi trường & Giao dịch

Thuật ngữTiếng AnhQuy ước dùng
môi trường thử nghiệmsandboxmôi trường thử nghiệm (sandbox) — dữ liệu giả, không tính tiền thật.
môi trường thậtproductionmôi trường thật (production) — dữ liệu và giao dịch thật.
trạng tháistatus / stateTrạng thái của bản ghi hoặc giao dịch.
giao dịchtransactionMột lần thanh toán/thao tác tài chính.
đơn vị bánmerchantđơn vị bán (merchant) — bên nhận thanh toán.
cổng thanh toánpayment gatewayLớp trung gian xử lý thanh toán.
SDKSDKBộ thư viện mẫu theo ngôn ngữ.
OAuth2 / OIDCOAuth2 / OpenID ConnectGiữ nguyên — chuẩn uỷ quyền / định danh.
Nếu một trang dùng từ khác với bảng này, bảng này là chuẩn. Thông báo cho đội tài liệu để đồng bộ.