Tài liệu API
Nhập trực tiếp URL JSON hoặc YAML trên vào Postman (Import → Link) hoặc Insomnia (Import → From URL).
v1 là API shield xác thực bằng key, ký bằng Ed25519. Mọi request (trừ JWKS) đều mang ?shield_key= (định dạng shpk_live_… / shpk_test_…). Response capture/complete là các envelope đã ký có thể xác minh dựa trên JWKS bên dưới — xem /v1/keys. Các route chỉ dành cho wallet trong API cũ không còn trong v1; dùng trực tiếp route PayPal/Stripe.
| host | mục đích |
|---|---|
https://live.vkl-shield.com | shield host live mặc định (production). Một đối tác có thể được cấp một shield host riêng — truyền nó làm selectBase của SDK (hoặc load script SDK từ host đó) thay cho host mặc định này. |
https://sandbox.vkl-shield.com | shield host sandbox mặc định (testing). Áp dụng cùng cơ chế ghi đè host riêng như trên host live mặc định. |
https://keys.vkl-shield.com | host JWKS chuẩn (live); sandbox là https://keys.vkl-shield.com/sandbox — luôn dùng host này cho JWKS bất kể request được phục vụ bởi shield host nào (mặc định hoặc riêng) |
Mọi request (trừ JWKS) mang tham số query shield_key. Phản hồi capture/completion là envelope đã ký — xem cách xác minh trong hướng dẫn PayPal SDK hoặc Stripe SDK.
PayPal
Stripe
- GET
/v1/stripe/select— Chọn một shield Stripe + publishable key từ pool của key - POST
/v1/stripe/create-intent— Tạo một PaymentIntent Stripe (deferred-intent cho wallet hoặc card-form) - POST
/v1/stripe/complete— Xác nhận một PaymentIntent đã thành công và nhận envelope đã ký - POST
/v1/wallet_beacon— Telemetry phía client theo kiểu best-effort (không bao giờ chặn checkout)