Bước 1: Mở trang Tích hợp
Chọn Gói, tích hợp & khởi tạo › Tích hợp (API, webhook). Tab API key liệt kê các key đã tạo: Tên, Quyền (kèm các tòa áp dụng), Dùng gần nhất. Bấm Tài liệu API để mở tài liệu cho bên kỹ thuật.
123- Danh sách API key
- Webhook
- Tài liệu cho lập trình viên
Bước 2: Tạo API key
Bấm Tạo API key. Nhập Tên (thiết bị / đối tác) (vd. Barrier hầm B1), tích Quyền cần dùng (vd. Xác thực mã khách, Xác thực biển số xe, Kiểm soát ra vào (cổng, barrier), Đọc hóa đơn), chọn Tòa áp dụng rồi bấm Tạo key.
12- Tên thiết bị / đối tác
- Tòa key được dùng
Bước 3: Lưu key ngay khi hiện
Hộp API key mới hiện key một lần duy nhất. Bấm Chép, dán vào thiết bị hoặc phần mềm đối tác, rồi bấm Tôi đã lưu. Mất key thì thu hồi và tạo key mới.
Bước 4: Thu hồi key không dùng nữa
Bấm Thu hồi ở dòng key. Thiết bị hoặc đối tác dùng key đó bị từ chối ngay lập tức; dòng chuyển nhãn Đã thu hồi.
Bước 5: Thêm webhook
Mở tab Webhook, bấm Thêm webhook. Nhập URL nhận (https), tích các Sự kiện (vd. Hóa đơn đã thanh toán, Phản ánh mới, Khách vào tòa, Cư dân được xác minh) rồi bấm Lưu. Secret ký webhook hiện một lần sau khi lưu; lưu lại để kiểm tra chữ ký.
1- Thêm webhook
Bước 6: Gửi thử và xem nhật ký
Ở mỗi webhook, bấm Gửi thử để gửi sự kiện thử "ping", Nhật ký để xem các lần gửi (thời gian, sự kiện, kết quả, lần thử). Lần gửi lỗi bấm Gửi lại. Biểu tượng bút để sửa, thùng rác để xóa webhook.
Mẹo & lưu ý
- Mỗi key nên dùng cho một thiết bị hoặc một đối tác để dễ thu hồi riêng.
- Key chỉ đọc, ghi dữ liệu của các tòa đã chọn trong phạm vi bạn quản lý.
- Không gửi API key hay secret qua tin nhắn, email hoặc yêu cầu hỗ trợ.
Thử trên bản demo
Đăng nhập web Ban quản lý bản demo bằng tài khoản mẫu và làm theo từng bước. Dữ liệu demo tự làm mới hằng ngày.