Nhận Tín hiệu mua bán của nebula

Endpoint này mô tả cấu trúc dữ liệu mà Đối tác cần xây dựng để nhận tín hiệu giao dịch từ hệ thống Simplize. Khi có tín hiệu mới, Simplize sẽ gửi một yêu cầu POST đến URL mà bạn đã cung cấp.

Yêu cầu kỹ thuật từ phía Đối tác

• URL: Endpoint do Đối tác cung cấp.
• Method: POST
• Content-Type: application/json

Xác thực (Authentication)

Để bảo mật, Simplize sẽ gửi kèm thông tin xác thực trong mỗi request. Endpoint của bạn cần hỗ trợ một trong các phương thức sau:

1. API Key

Hệ thống Simplize sẽ gửi một API Key bí mật trong Header hoặc Query Parameter của request.

• Auth Type: API_KEY
• Vị trí: Header hoặc Query Parameter.
• Tên Key: Tên của header hoặc query parameter (Ví dụ: X-API-Key).
• Giá trị Key: Chuỗi API key bí mật do bạn cung cấp.

2. Basic Authentication

Hệ thống Simplize sẽ gửi thông tin xác thực theo chuẩn Basic Authentication trong Header.

• Auth Type: BASIC
• Username: Tên người dùng do bạn cung cấp.
• Password: Mật khẩu do bạn cung cấp.

3. None

Nếu đối tác có các biện pháp bảo mật khác như IP Whitelisting, bạn có thể chọn không yêu cầu xác thực trực tiếp trên request.

• Auth Type: NONE

Request Body

Đây là cấu trúc request body mà hệ thống Simplize sẽ gửi đến endpoint của bạn.

Request Body Mẫu

{
  "{externalUserId_1}": [
    {
      "ticker": "VIC",
      "type": "BUY",
      "volume": 100,
      "date": "2024-01-15T10:30:00Z",
      "createdDate": "2024-01-15T10:30:00Z"
    }
  ],
  "{externalUserId_2}": [
    {
      "ticker": "VNM",
      "type": "SELL",
      "volume": 200,
      "date": "2024-01-15T10:40:00Z",
      "createdDate": "2024-01-15T10:40:00Z"
    }
  ]
}

Chi tiết các trường

Tên Thuộc Tính	Kiểu Dữ Liệu	Mô Tả
{externalUserId}	string	Key của object chính. Là externalUserId của người dùng trong hệ thống của đối tác, đã được map với hệ thống Simplize.
ticker	string	Mã cổ phiếu.
type	string	Loại tín hiệu: "BUY" hoặc "SELL".
volume	number	Khối lượng giao dịch.
date	string	Thời gian của tín hiệu (định dạng ISO 8601).
createdDate	string	Thời gian tạo tín hiệu (định dạng ISO 8601).

Phản hồi (Response)

Để xác nhận đã nhận được dữ liệu thành công, endpoint của bạn cần phản hồi với HTTP Status Code 200 OK và không cần đính kèm body.

Response Mẫu

HTTP/1.1 200 OK

Chi tiết Response

Thành phần	Mô tả
Status Code	200 OK: Yêu cầu đã được tiếp nhận và xử lý thành công. Bất kỳ mã trạng thái nào khác (ví dụ: 4xx, 5xx) sẽ được coi là thất bại và kích hoạt cơ chế retry từ hệ thống Simplize.