SePay CLI chỉ quản lý API Token sandbox, với dữ liệu giả lập, không ảnh hưởng đến production. API Token production có quyền trên cả công ty nên chỉ tạo và thu hồi trên my.sepay.vn, xem Tạo API Token; CLI không tạo, xem hay thu hồi token production.
Code tích hợp của bạn gọi SePay API bằng API Token, gửi trong header Authorization: Bearer <API Token>. Trên sandbox, tạo và quản lý token đó bằng nhóm lệnh sepay apikey (viết tắt sepay ak). Bản thân CLI đăng nhập bằng sepay login, không dùng API Token.
apikey create
Tạo một API Token sandbox:
$ sepay apikey create --name "may-chu-dev"Lệnh in Created API key <xid>. rồi in thông tin token, dòng Key là token đầy đủ.
| Flag | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
--name | string | Có | Tên token, tối đa 200 ký tự |
--active | bool | Không | Mặc định true. --active=false tạo token ở trạng thái tắt |
apikey create là lệnh duy nhất in token đầy đủ; các lệnh khác chỉ hiện bản đã che. Lưu token vào biến môi trường hoặc kho secret của dự án ngay lúc đó. Mất token thì tạo token mới rồi xóa token cũ.
apikey list và apikey get
Liệt kê các API Token sandbox của công ty. Cột KEY hiện token đã che:
$ sepay apikey listXem một token theo xid. Bỏ trống xid thì CLI hiện danh sách để chọn:
$ sepay apikey get <xid>apikey update
Tắt một token mà không xóa, ví dụ khi tạm ngừng một môi trường thử:
$ sepay apikey update <xid> --active=falseBật lại bằng --active, đổi tên bằng --name "<tên mới>".
apikey delete
Xóa một token:
$ sepay apikey delete <xid> --yesLệnh luôn hỏi xác nhận, chạy trong script thì cần --yes. Token đã xóa không khôi phục được, và code đang dùng token đó sẽ bị SePay từ chối.
Thông báo lỗi
| Thông báo | Nguyên nhân | Cách xử lý |
|---|---|---|
apikey list is sandbox-only; drop --env production | Chạy lệnh apikey với --env production | Bỏ --env production; token production tạo trên my.sepay.vn |
an API key xid is required | get, update hoặc delete chạy trong script mà không truyền xid | Truyền xid lấy từ apikey list |
--name is required | create chạy trong script mà không có --name | Thêm --name "<tên>" |
nothing to update; pass --name and/or --active | update không có --name lẫn --active | Thêm flag cần đổi |
no API keys yet; create one with: sepay apikey create --name <name> | Công ty chưa có API Token sandbox nào | Tạo token bằng apikey create |