Xác thực

Mọi endpoint của API Tools HiTechCloud cần khoá API gửi qua header X-API-Key; tìm hiểu phạm vi, danh sách IP, giới hạn tần suất và cách xoay vòng khoá an toàn.

Xem Markdown

Gửi khoá trong header X-API-Key ở mỗi yêu cầu. Thiếu hoặc sai khoá, server trả 401 kèm mã lỗi để bạn biết nguyên nhân.

bash
curl 'https://api-tools.hitechcloud.vn/api/countries' \
  -H "X-API-Key: $HITECH_API_KEY"
Không bao giờ đặt khoá trong URL, mã front-end hoặc kho mã nguồn. Gọi API từ server của bạn và giữ khoá trong biến môi trường hoặc kho bí mật.

Phạm vi của một khoá

  • Nhóm dịch vụ — mỗi khoá chỉ gọi được các nhóm bạn bật (ví dụ chỉ “Doanh nghiệp & Thuế”).
  • Endpoint hạn chế — một số endpoint cần xin quyền riêng trong Cổng khách hàng.
  • Danh sách IP — tuỳ chọn, chỉ cho phép lời gọi từ các IP bạn khai.
  • Hết hạn / thu hồi — khoá hết hạn hoặc bị thu hồi sẽ bị từ chối ngay.
  • Tốc độ & hạn mức — số lượt gọi mỗi phút của khoá và hạn mức tháng của tổ chức.

Xoay vòng khoá

  1. Tạo khoá mới trong Cổng khách hàng.
  2. Cập nhật ứng dụng sang khoá mới và triển khai.
  3. Thu hồi khoá cũ — nhật ký gọi API cho biết khoá cũ còn được dùng ở đâu.

Các lỗi xác thực và cách xử lý nằm ở trang Mã lỗi.