Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xanhcard.com/llms.txt

Use this file to discover all available pages before exploring further.

Hành động (Actions) là gì?

Hành động là các thao tác được thực hiện tự động khi một thẻ được quét. Các hành động chạy theo thứ tự từ trên xuống dưới. Mỗi hành động có thể có điều kiện CEL để kiểm soát khi nào nó được thực hiện.

Các loại hành động

Validate Pass

Kiểm tra tính hợp lệ của thẻ. Đây thường là hành động đầu tiên để đảm bảo thẻ hợp lệ trước khi thực hiện các hành động khác.

Increment

Tăng giá trị của một trường dữ liệu số (ví dụ: số lần ghé thăm, điểm tích lũy). Hành động Increment
  • Field Name: Tên trường dữ liệu cần tăng
  • Value: Giá trị tăng thêm (mặc định là 1)
  • Label (for scanner input): Nhãn hiển thị trên giao diện quét
  • Placeholder: Văn bản gợi ý trong ô nhập
  • Show in Additional params: Hiển thị trường này trong phần tham số bổ sung

Decrement

Giảm giá trị của một trường dữ liệu số (ví dụ: số vé còn lại, số lượt sử dụng). Cấu hình tương tự như Increment:
  • Field Name: Tên trường dữ liệu cần giảm
  • Value: Giá trị giảm đi (mặc định là 1)

Update Data

Cập nhật dữ liệu trên thẻ bằng JSON object.
{
  "status": "checked_in",
  "checkInTime": "2024-01-15T09:00:00Z"
}
  • Nhập đối tượng JSON với các trường cần cập nhật
  • Giá trị có thể là tĩnh hoặc dùng biến dữ liệu

Void

Vô hiệu hóa thẻ. Sau khi thực hiện, thẻ sẽ không còn hiệu lực và không thể sử dụng được nữa.

Sync

Đồng bộ dữ liệu thẻ với máy chủ. Hành động này đảm bảo dữ liệu trên thẻ được cập nhật mới nhất.

Notify

Gửi thông báo đẩy đến người dùng thẻ. Hành động Notify
  • Notification Message: Nội dung thông báo gửi đến người sở hữu thẻ
  • Translations: Thêm bản dịch cho nhiều ngôn ngữ khác nhau
Thông báo sẽ hiển thị trên màn hình khóa của điện thoại người dùng.

Webhooks

Gọi một webhook URL khi quét thẻ để tích hợp với hệ thống bên ngoài. Hành động Webhooks
  • Webhook URL: URL endpoint nhận dữ liệu
  • Authentication: Phương thức xác thực
    • None: Không xác thực
    • Bearer Token: Sử dụng token Bearer
    • API Key: Sử dụng API key
    • Basic Auth: Xác thực cơ bản username/password
  • Include in Payload: Chọn dữ liệu gửi kèm
    • Pass ID
    • External ID
    • Scanner ID
    • Scanner Name
    • Project ID
    • Scanned At
    • Pass Data
Webhook giúp tích hợp XanhCard với các hệ thống bên thứ ba như CRM, POS, hoặc hệ thống quản lý sự kiện.

Scan Once

Chỉ cho phép quét thẻ một lần duy nhất. Sau khi quét, thẻ sẽ không thể quét lại được nữa.

Điều kiện hành động (CEL Rule Expression)

Bạn có thể đặt điều kiện cho mỗi hành động bằng biểu thức CEL:
pass.data.visits < 10
pass.data.status == "active"
pass.data.ticketType == "VIP"
Nếu điều kiện không thỏa mãn:
  • Hành động đó sẽ không được thực hiện
  • Thông báo lỗi sẽ hiển thị trên giao diện quét
  • Các hành động tiếp theo sẽ không được thực hiện
Dùng Error Message để tùy chỉnh thông báo khi điều kiện không thỏa mãn. Ví dụ: “Thẻ này đã được sử dụng” hoặc “Thẻ này không còn hiệu lực.”

Thứ tự hành động

Các hành động được thực hiện theo thứ tự từ trên xuống dưới. Bạn có thể sắp xếp lại thứ tự bằng nút Move upMove down. Ví dụ luồng hành động cho sự kiện:
1

Validate Pass

Kiểm tra thẻ có hợp lệ không
2

Scan Once

Đảm bảo thẻ chưa được quét trước đó
3

Increment

Tăng số lần check-in
4

Update Data

Cập nhật trạng thái thành “checked_in”
5

Notify

Gửi thông báo chào mừng đến người dùng