Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Sử dụng Client mẫu

SSI hỗ trợ hai sample mẫu là Nodejs và Python

Đường dẫn dịch vụ

Hiện FastConnect Data được truy cập qua các url sau:

  • URL api: https://fc-data.ssi.com.vn/v2.0/Market

  • URL streaming giá đối với Nodejs: wss://fc-datahub.ssi.com.vn/v2.0

  • URL streaming giá đối với Python/ .Net: https://fc-datahub.ssi.com.vn

  • URL api Java/ .Net: https://fc-data.ssi.com.vn/

  • URL streaming giá đối với Java: https://fc-datahub.ssi.com.vn/

SSI cung cấp sample code cho ba ngôn ngữ lập trình là Python, Nodejs, Java và .Net. Tên thường gọi là Client Python, Client Nodejs, Client Java và .Net.

Client Python

Cài đặt

Đường dẫn tải client

https://github.com/SSI-Securities-Corporation/python-fcdata

Cài đặt 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 ý: Bạn nhớ tick Add system path khi setup Python

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:

Cửa sổ cmd

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

Minh họa màn hình cài đặt thành công

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. Chi tiết tại đây.

Chạy Client

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

  • config.py là file lưu các cấu hình kết nối đến dịch vụ (ConsumerID, ConsumerSecret và PrivateKey). Bạn sẽ cần nhập các thông tin kết nối lấy được trên iBoard ở bước Đăng ký dịch vụ vào đây trước khi chạy thử client.

  • test_Req_Res.py là file dùng để chạy thử các api

  • test_Streaming.py là file dùng để chạy thử kết nối streaming

Chạy API

File test_Req_Res.py 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 test_Req_Res.py (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Minh họa tham số đầu vào trong file

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

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

Bước 2: Nhập input cho hàm cần truy vấn từ số 11 -> 18

Minh họa màn hình gọi hàm truy vấn thành công

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

Bước 1: Chạy file test_Streaming.py bằng câu lệnh: python test_Streaming.py

Bước 2: Nhập loại dữ liệu cần cập nhật streaming là một trong các giá trị sau:

  • ALL: Tất cả dữ liệu

  • F: Trạng thái mã chứng khoán

  • X: Dữ liệu giá mua bán tốt nhất

  • R: Room giao dịch nước ngoài

  • MI: Dữ liệu chỉ số

  • B: Dữ liệu OHLC realtime

Xem mô tả từng loại dữ liệu streaming chi tiết tại mục 2. Streaming FastConnect Data

Ví dụ, muốn nhận thông tin streaming cập nhật chỉ số VN30, người dùng cần nhập thông tin là MI:VN30

Streaming chỉ số VN30

Lưu ý: Khi nhập dữ liệu streaming là ALL, lượng dữ liệu trả ra lớn, có thể gây chậm phía client

Client Nodejs

Cài đặt

Đường dẫn tải Client

https://github.com/SSI-Securities-Corporation/node-fcdata

Hoặc người dùng có thể đăng nhập iBoard, vào mục Dịch vụ API/Quản lý dịch vụ và click tải Client từ đây (xem ảnh minh họa bên dưới).

Cài đặt Nodejs

Máy tính cần cài đặt Nodejs version v.10.15.3 trở lên.

Để kiểm tra máy tính đã cài đặt Nodejs và version đã cài, chạy câu lệnh

Kiểm tra version Nodejs

Cài đặt Nodejs 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

Bước 3: Cài đặt Client bằng cách chạy câu lệnh sau

Màn hình trả hết quả như ảnh

Minh họa cài đặt Client thành công

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 hướng dẫn tại đây.

Chạy Client

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

  • config.js: là file lưu các cấu hình kết nối đến dịch vụ (Đường dẫn dịch vụ, ConsumerID, ConsumerSecret và PrivateKey). Bạn sẽ cần nhập các thông tin kết nối lấy được trên iBoard ở bước Đăng ký dịch vụ vào đây trước khi chạy thử client.

  • main.js là file dùng để chạy thử các api và nhận streaming giá

Thay cấu hình kết nối vào config.js

Người dùng sử dụng thông tin kết nối lấy trên iBoard và thay vào file rồi lưu file.

  • ConsumerId

  • ConsumerSecret

Điền file config.js

Chạy test

File main.js 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 main.js (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Để chạy test, thực hiện quy trình sau:

Bước 1: mở cmd và chạy câu lệnh

Sau khi chạy thành công, màn hình sẽ hiển thị thông báo:

Example app listinging on port <số port>!

Người dùng lưu ý số port này để sử dụng ở bước tiếp theo.

Ví dụ, ở màn hình dưới, app được chạy ở port 3020.

Minh họa chạy client thành công

Bước 2: Mở trình duyệt và gõ đường dẫn sau

Thông tin được trả ra ngay trên màn hình trình duyệt.

Ví dụ:

Lấy danh sách các mã sàn HOSE, sử dụng hàm Securities, người dùng thực hiện như sau:

  • Mở file main.js, tìm đến hàm Securities, điền HOSE vào trường market và lưu thay đổi vào file.

Minh họa sửa đầu vào của hàm trong file main.js
Minh họa dữ liệu trả ra của hàm Securities

Streaming Market data

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

Bước 3: Vào file main.js xuống dòng 183 điền kênh muốn truy vấn -> Save

Client Java

Cài đặt

Đường dẫn tải client

https://github.com/SSI-Securities-Corporation/java-fcdata

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 sau khi giải nén

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

Màn hình hiển thị khi gõ cmd

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

Màn hình minh họa cài đặt thành công

Chạy Client

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

  • fcdata.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 fcdata.json và điền bộ key kết nối

Điền key

File fcdata.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 fcdata.json (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Điền các tham số đầu vào trong file

Để 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

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

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ố 9 để khởi tạo lại Client

  • Khởi tạo lại Client -> Chọn số 3 để Exit

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

Bước 1: Điền key kết nối và nhập thông tin input stream (trường channels) muốn nghe -> Lưu

Xem mô tả từng loại dữ liệu streaming chi tiết tại mục 2. Streaming FastConnect Data

Điền key lựa chọn stream muốn nghe

Bước 2: Chạy Client và lựa chọn 2 để nghe stream như ảnh

Màn hình hiển thị stream

Lưu ý:

  • Điền lại key kết nối hoặc thay đổi thông tin nghe stream cần Lưu file và chọn số 9 để khởi tạo lại Client

  • Khởi tạo lại Client -> Chọn số 3 để Exit

Client .NET

Cài đặt

Đường dẫn tải client

https://github.com/SSI-Securities-Corporation/dotnet-fcdata/releases/latest/download/fc-data-win64.net.zip

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:

Màn hình sau khi giải nén

Bước 2: Mở Client

Double click vào icon dòng text "DotnetClientTest"

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

Client cài đặt thành công

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

màn hình hiển thị file data

Chạy API

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

File fcdata 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 fcdata (bằng Notepad ++…) và chỉnh sửa rồi lưu lại.

Thay đổi thông tin input

Để 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

Bước 2: Chạy Client và lựa chọn 2 + 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ố 10 để khởi tạo lại Client

  • Khởi tạo lại Client -> Chọn số 3 để Exit

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

Bước 1: Điền key kết nối và nhập thông tin input stream (trường channels) muốn nghe -> Lưu

Xem mô tả từng loại dữ liệu streaming chi tiết tại mục 2. Streaming FastConnect Data

Điền stream muốn nghe

Bước 2: Chạy Client và lựa chọn 1 để nghe stream như ảnh

Thông tin stream

Lưu ý:

  • Điền lại key kết nối hoặc thay đổi thông tin nghe stream cần Lưu file và chọn số 10 để khởi tạo lại Client

  • Khởi tạo lại Client -> Chọn số 3 để Exit

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

Last updated