Chuyển tới nội dung chính

SSI Guide Portal API (1.0.0)

Download OpenAPI specification:Download

Read-only HTTP API for the SSI customer guide portal. Source of truth is the same catalog served at https://huongdankhachhang.hocchungkhoan.com.vn/

Categories

List guide categories

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Guides

List guides

Filter by categoryId and search query. Search is accent-insensitive.

query Parameters
categoryId
string
Example: categoryId=account

Category id. all or omitted returns every category.

q
string

Search title, shortDesc, and tags.

page
integer >= 1
Default: 1
pageSize
integer [ 1 .. 100 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get one guide

path Parameters
id
required
string
Example: guide-1

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

FAQ

List FAQ items

query Parameters
category
string
Example: category=money

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}