Môi trường và cấu hình SePay CLI

Chọn môi trường sandbox hoặc production cho lệnh SePay CLI, đổi môi trường mặc định cho mọi lệnh và biết CLI lưu cấu hình, thông tin đăng nhập ở đâu.

||

Hai môi trường

Sandbox dùng dữ liệu Test mode (chế độ thử nghiệm), không có tiền thật. Production là dữ liệu và giao dịch thật. Dữ liệu hai bên tách biệt hoàn toàn: xid tạo trên sandbox không tồn tại trên production.

Chọn môi trường

Thêm --env production hoặc --env sandbox để chọn môi trường cho một lệnh. Lệnh không có --env chạy trên môi trường mặc định, và mặc định là sandbox.

Đặt sandbox làm môi trường mặc định cho mọi lệnh:

$ sepay config set default_env sandbox

Đặt production làm môi trường mặc định. CLI hỏi xác nhận trước khi lưu:

$ sepay config set default_env production

default_env lưu trong config.yml. Giá trị trong cấu hình không hợp lệ thì CLI cảnh báo và chạy trên sandbox.

Thông tin môi trường đang chạy

Lệnh làm việc với dữ liệu SePay in ra môi trường đang dùng, để bạn nhìn là biết mình đang ở sandbox hay production. Dòng này không có khi dùng --json, -o yaml hoặc --quiet.

env: sandbox

Chạy lệnh trên production

Mọi lệnh sửa dữ liệu trên production chỉ chạy khi bạn tự xác nhận trên terminal của mình. AI không tự xác nhận thay bạn: gặp lệnh này, AI đưa lệnh để bạn tự chạy.

Lệnh phải có --env production ngay trên dòng lệnh; default_env: production không tính. Lệnh in dòng env: production, dòng ! live: ... targets PRODUCTION rồi hỏi xác nhận trước khi chạy.

Ví dụ đổi tên một webhook trên production:

$ sepay webhook update 5f0e2a7b-xxxx-xxxx-xxxx-fa163e2f7c98 --name "Webhook don hang" --env productionenv: production! live: update webhook targets PRODUCTION? update webhook on production? [y/N]

Gõ y rồi Enter để chạy. Enter (mặc định là No) hoặc n thì lệnh hủy và báo Error: update webhook cancelled. Bấm Ctrl+C hoặc Esc cũng hủy lệnh, với exit code 130 và không in lỗi.

Không có terminal để trả lời thì lệnh dừng với exit code 2. Script bạn tự viết chạy được với --env production, id tài nguyên và --yes; lệnh không có id chỉ chạy trên terminal (luật đầy đủ). Muốn xem trước lệnh sẽ gửi gì thì thêm --dry-run (Chạy thử). Exit code 5 nghĩa là token thiếu scope cho lệnh đó: đăng nhập lại và cấp thêm scope.

Lệnh chỉ chạy trên sandbox

Các lệnh trong bảng dừng với exit code 2 nếu chạy với --env production:

$ sepay va issue --env productionError: va issue is sandbox-only; drop --env productionRun 'sepay va issue --help' for usage.

Khi default_env là production và lệnh không có --env, nhóm sandbox, pg, bankhub, einvoice và lệnh webhook test vẫn chạy trên sandbox; các lệnh còn lại trong bảng dừng với exit code 2.

Nhóm lệnhMô tả
sandboxQuản lý dữ liệu sandbox, tạo và reset.
pgCổng thanh toán (sandbox).
bankhubBank Hub (sandbox).
einvoiceHóa đơn điện tử (sandbox).
apikeyQuản lý API Token sandbox. API Token production tạo và thu hồi trên my.sepay.vn.
bank-account (create, delete)Tạo/xóa tài khoản ngân hàng sandbox.
va (issue, revoke)Quản lý Virtual Account sandbox.
webhook (listen, test, create/update --listen-only)Quản lý webhook sandbox.

Tệp cấu hình

Hệ điều hànhThư mục cấu hình
Linux~/.config/sepay/ (hoặc $XDG_CONFIG_HOME/sepay/)
macOS~/Library/Application Support/sepay/
Windows%AppData%\sepay\

Hai tệp chính trong thư mục này đều có quyền 0600. config.yml giữ môi trường mặc định, do sepay config set ghi. hosts.yml giữ các profile đã đăng nhập, kèm token khi đăng nhập với --insecure-storage, do sepay login và các lệnh sepay auth ... ghi.

Khi đăng nhập với --insecure-storage, hoặc chạy sepay pg auth, sepay bankhub auth, sepay einvoice auth với cờ này, thông tin xác thực của pg, bankhub, einvoice nằm trong products.yml ở cùng thư mục. Máy không có keychain dùng được thì sepay login tự lưu token vào hosts.yml như khi có --insecure-storage và in cảnh báo; profile đó tiếp tục dùng tệp ở các lần sau.

Dùng một tệp cấu hình có sẵn khác bằng --config <file> (CLI đọc cả hosts.yml trong thư mục chứa tệp đó), hoặc đổi cả thư mục bằng biến SEPAY_CONFIG_DIR, chẳng hạn để mỗi agent có thông tin đăng nhập riêng.

Biến môi trường

BiếnMô tả
SEPAY_CONFIG_DIRThư mục cấu hình và profile.
SEPAY_PROFILEProfile được sử dụng (tương đương --profile).
NO_COLOR1 để tắt màu.
SEPAY_NO_UPDATE_NOTIFIER1 để tắt thông báo có phiên bản mới hoặc phiên bản đang dùng bị ngừng hỗ trợ (Cài đặt SePay CLI). Biến CI được bật cũng tắt thông báo này.
SEPAY_LANGNgôn ngữ màn hình sepay login: vi hoặc en. Bỏ trống thì theo locale của máy (Ngôn ngữ màn hình đăng nhập).

CLI xét giá trị của NO_COLOR và SEPAY_NO_UPDATE_NOTIFIER: 0, false, no, off và giá trị rỗng đều là tắt, nên NO_COLOR=0 vẫn giữ màu.

Không có biến môi trường nào để truyền token: thông tin đăng nhập chỉ vào CLI qua sepay login. Máy không mở được trình duyệt thì xem Đăng nhập trên máy không có trình duyệt.