Sử dụng Client mẫu

PreviousHướng dẫn kết nối NextDanh sách các API

Last updated 1 year ago

Sử dụng Client mẫu

Python Client

Cài đặt Client

Đường dẫn tải Client:

Yêu cầu về Python

Yêu cầu cài đặt Python 3.x trở lên (có thể tải bản python.org/downloads/release/python-370/)

Lưu ý: Nhớ tick Add system path khi cài đặt Python

Cài đặt Client

Bước 1: Giải nén file Client đã tải

Bước 2: Gõ cmd vào ô địa chỉ thư mục để khởi tạo command line

Màn hình hiển thị cửa sổ như sau:

Bước 3: Điền thông tin trong file fc_config.py tại thư mục examples

Lưu ý: TwoFAType = 0: PIN và 1: OTP (SMS/ Email/ SmartOTP)

Bước 4: Chạy câu lệnh

pip install ssi-fctrading

Lưu ý: Đối với khách hàng dùng mạng có proxy thì thực hiện các bước cấu hình proxy trước khi chạy câu lệnh cài đặt. Xem chi tiết tại đây.

Lưu ý:

+ Chỉ cài đặt 1 lần duy nhất. Lần tiếp chạy chỉ cần click douple vào file example_api và example_stream

Đặt/sửa/hủy lệnh và truy vẫn thông tin tại link: http://127.0.0.1:8000/docs (khoanh đỏ trong ảnh)
Nghe streaming lệnh

+ File example_api và example_streaming đã bao gồm hết các hàm trong link đính kèm

Chạy Client

Sau khi cài đặt, trong thư mục sẽ có các file sau:

fc_config.py: file chứa các cấu hình kết nối
example_api: file chạy test các câu lệnh api
example_stream: file test kết nối streaming

Cấu hình kết nối

Nhập thông tin consumerID, consumerSecret, privateKey của bạn vào file fc_config.py. Nhập phương thức xác thực mà bạn đã đăng ký vào trường twoFAtype và lưu file. Lưu ý: Điền 0 nếu bạn dùng PIN. Điền 1 nếu bạn dùng SMS OTP/Email OTP/Smart OTP.

Chạy test api

Streaming

Click douple vào file example_stream để nghe Streaming lệnh. Thông tin như ảnh:

Nodejs Client

Cài đặt Client

Đường dẫn tải Client

Yêu cầu về Node.js

Máy tính cần có cài đặt Node.js (cài đặt từ bản v.10.15.3 trở lên)
Kiểm tra máy tính đã cài đặt Node.js và version bằng câu lệnh: cmd node –version

Cài đặt Client

Bước 2: Gõ cmd vào ô địa chỉ thư mục để khởi tạo command line

Bước 3: Chạy câu lệnh sau để cài đặt

npm install ssi-fctrading

Lưu ý: Đối với khách hàng dùng mạng có proxy thì thực hiện các bước cấu hình proxy trước khi chạy câu lệnh cài đặt. Xem chi tiết tại đây.

Chạy Client

Sau khi cài đặt, trong thư mục sẽ có các file index.js. File này chứa toàn bộ các thông tin kết nối, dữ liệu test và là file chạy chính. Bạn cần chỉnh cấu hình và dữ liệu phù hợp trước khi chạy. Các bước thực hiện chi tiết như sau:

Cấu hình kết nối

Nhập giá trị ConsumerID, ConsumerSecret, PrivateKey tại mục config trong file index.js bằng bộ key kết nối của bạn.
Cấu hình phương thức bạn đang sử dụng vào trường TwoFAType. Nếu bạn dùng PIN, nhập 0. Nếu bạn dùng SMS OTP/Email OTP/SmartOTP, nhập 1.

Nhập thông tin tài khoản/lệnh

Trong file index.js, biến "mockStockData" chứa các thông tin dùng để đặt lệnh cơ sở và "mockDerivativeData" chứa các thông tin dùng để đặt lệnh phái sinh. Bạn cần chỉnh sửa thông tin cho phù hợp: số tài khoản đặt lệnh, loại lệnh, mã chứng khoán, giá, khối lượng... và thực hiện lưu file.

Nhập mã xác thực

Nhập mã xác thực vào trường code ở 2 hàm “mockStockData” và “mockDeterativeData” trong file index.js và lưu file.

Cách lấy mã xác thực:

Khách hàng sử dụng PIN để giao dịch, nhập mã PIN
Khách hàng dùng SMS/Email OTP: mở trình duyệt và chạy localhost:3011/getOTP để lấy mã OTP.

Khách hàng dùng SmartOTP: lấy mã OTP trên ứng dụng SSI SmartOTP hoặc iBoard tùy theo bạn kích hoạt SmartOTP trên ứng dụng nào.

Chạy ứng dụng

Mở cmd và chạy lại câu lệnh: node index.js

Đặt lệnh và theo dõi streaming

Mở trình duyệt và gõ câu lệnh sau: localhost:3011/NewOrder
Theo dõi streaming lệnh trên màn hình cmd trước đó đã chạy file index.js

Bạn cũng có thể chạy thử các hàm truy vấn khác bằng cách gõ tương ứng tên các hàm có trong file index.js

Ví dụ để lấy sức mua của tài khoản, chạy câu lệnh localhost:3011/maxBuyQty

Streaming trạng thái lệnh chỉ có khi đặt/sửa/hủy/khớp lệnh.

Streaming danh mục phái sinh chỉ có khi có khớp lệnh hoặc khi mã trong danh mục có thay đổi giá thị trường.

Client Java

Cài đặt

Đường dẫn tải client

Cài đặt Java

Yêu cầu máy tính hoặc laptop cần cài đặt java

Cài đặt Client

Bước 1: Giải nén

Bước 2: Gõ cmd vào ô địa chỉ thư mục để khởi tạo command line

Màn hình hiển thị cửa sổ như sau:

Bước 3: Chạy câu lệnh cài đặt

java -jar <tensamplejava>.jar

Chạy Client

Trong thư mục vừa cài đặt thành công sẽ có các file sau:

fctrading.json là file dùng để điền key kết nối và chạy thử API
samples-2.0.0 là run file jar

Chạy API

Người dùng mở file fctrading.json và điền bộ key kết nối

File fctrading.json chứa sẵn mẫu đầu vào cho các hàm. Người dùng có thể sử dụng luôn các đầu vào này để chạy hoặc chỉnh sửa đầu vào tùy nhu cầu.

Nếu muốn chỉnh tham số đầu vào, người dùng mở file fctrading.json (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Để chạy test thử các api, thực hiện các step sau:

Bước 1: Điền key kết nối và nhập thông tin input các hàm API muốn chạy -> Lưu

Lưu ý:

code: Điền mã PIN nếu Khách hàng sử dụng phương thức xác thực là PIN
Nếu khách hàng sử dụng phương thức xác thực OTP -> không bắt buộc điền

Bước 2: Chạy Client và lựa chọn 1 + Thứ tự API tương ứng để kiểm tra dữ liệu API

Lưu ý:

Điền lại key kết nối hoặc thay đổi input API cần Lưu file và chọn số 35 để khởi tạo lại Client
Khởi tạo lại Client -> Chọn số 3 để Exit
Nếu khách hàng sử dụng phương thức xác thực là OTP -> Khởi tạo lần đầu tiên hệ thống mặc định isSave = false và yêu cầu nhập OTP
Phương thức xác thực OTP và isSave = false -> Trước khi giao dịch đều cần nhập mã OTP

Kết nối streaming dữ liệu

Điền key kết nối và chọn số 2 để nghe FCTrading streaming -> Lưu

Client .Net

Cài đặt

Đường dẫn tải client

Cài đặt Client

Bước 1: Giải nén

Màn hình giải nén hiển thị thông tin như sau:

Bước 2: Mở Client

Double click vào icon dòng text "SSI.FCTrading.ClientExample"

Client hiển thị thông tin như sau:

Chạy Client

Trong thư mục vừa cài đặt thành công có file sau:

data là file dùng để điền key kết nối và chạy thử API

Chạy API

Người dùng mở file data và điền bộ key kết nối

File data chứa sẵn mẫu đầu vào cho các hàm. Người dùng có thể sử dụng luôn các đầu vào này để chạy hoặc chỉnh sửa đầu vào tùy nhu cầu.

Nếu muốn chỉnh tham số đầu vào, người dùng mở file data (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Để chạy test thử các api, thực hiện các step sau:

Bước 1: Điền key kết nối và nhập thông tin input các hàm API muốn chạy -> Lưu

Lưu ý:

code: Điền mã PIN nếu Khách hàng sử dụng phương thức xác thực là PIN
Nếu khách hàng sử dụng phương thức xác thực OTP -> không bắt buộc điền

Bước 2: Chạy Client và lựa chọn 1 + Thứ tự API tương ứng để kiểm tra dữ liệu API

Lưu ý:

Điền lại key kết nối hoặc thay đổi input API cần Lưu file và chọn số 19 để khởi tạo lại Client
Khởi tạo lại Client -> Chọn số 3 để Exit
Nếu khách hàng sử dụng phương thức xác thực là OTP -> Khởi tạo lần đầu tiên hệ thống mặc định isSave = false và yêu cầu nhập OTP (chọn số 1 để lấy OTP)
Phương thức xác thực OTP và isSave = false -> Trước khi giao dịch đều cần nhập mã OTP

Kết nối streaming dữ liệu

Điền key kết nối và chọn số 2 để nghe FCTrading streaming -> Lưu

PreviousHướng dẫn kết nối NextDanh sách các API

Last updated 1 year ago