Hướng dẫn tích hợp API

Tổng quan

Loại API: REST APIs
Kiểu dữ liệu: JSON
Đặc tả API: Xem đặc tả

Các thuộc tính dùng chung

Các thuộc tính này sẽ xuất hiện ở trong tất cả các request và response, bao gồm:

Request

"RequestInfo": {
    "PrivateKey": "string",
    "ApiAccount": "string",
    "ApiPassword": "string",
    "Currency": "string",
    "Language": "string",
    "IpAddress": "string"
  }
Trường thông tin Mô tả Kiểu dữ liệu Bắt buộc Ví dụ
RequestInfo Thông tin truy vấn object Có  
PrivateKey
 Khóa bảo mật string Có 0
ApiAccount
Tài khoản sử dụng API
 string Có DC120386
ApiPassword
 Mật khẩu sử dụng API string Có  
Currency
 Đơn vị tiền tệ string Có VND
Language
 Ngôn ngữ truy vấn string Có vi
IpAddress
 Địa chỉ IP truy vấn string Có 10.0.0.1
  • Khóa bảo mật và tài khoản sử dụng API sẽ được chúng tôi gửi tới bạn khi đăng ký sử dụng API. Nếu bạn chưa có tài khoản, vui lòng đăng ký tại đây
  • Bạn truyền mã ngôn ngữ nào vào request, thông báo lỗi và dữ liệu sẽ được trả về theo ngôn ngữ tương ứng. Hiện tại hệ thống hỗ trợ 02 ngôn ngữ: Tiếng Anh (en) và Tiếng Việt (vi)
  • Hiện tại API chỉ đang hỗ trợ tìm kiếm chuyến bay, dịch vụ bằng loại tiền VND, chúng tôi sẽ sớm bổ sung thêm các loại tiền tệ khác vào hệ thống.
  • Vui lòng truyền địa chỉ IP của khách hàng mua vé trên website, ứng dụng của bạn, điều này sẽ hữu ích khi cần tra cứu, hỗ trợ, hoặc chặn những truy vấn không hợp lệ.
  • Vui lòng bỏ qua các thông tin khác có trong đặc tả API nhưng không được mô tả trong tài liệu.

Response

{
  "StatusCode": "string",
  "Success": true,
  "Message": "string",
  "Language": "string",
  "RequestID": 0
}
Trường thông tin Mô tả Kiểu dữ liệu Ví dụ
StatusCode
Mã trạng thái trả về
 string 0000
Success
 Kết quả của truy vấn bool true
Message
Thông báo trả về
 string  
Language
Ngôn ngữ
 string vi
RequestID
ID của request
 string 987654321
  • Khi một truy vấn được thực hiện thành công, StatusCode sẽ có giá trị là 000 hoặc 0000 và Success là true
  • Khi một truy vấn bị lỗi, StatusCode sẽ trả về mã lỗi cụ thể và Success là false
  • Trong trường hợp truy vấn gặp lỗi chưa xác định, StatusCode sẽ trả về giá trị 001 (lỗi chung). Cần đọc thông báo trong trường Message và hỏi trợ giúp.
  • Trong trường hợp truy vấn với ngôn ngữ là Tiếng Việt (vi) nhưng lỗi chưa xác định, API vẫn trả về Message bằng Tiếng Anh.
  • Mỗi một truy vấn sẽ được trả về thông tin RequestID, khi có yêu cầu trợ giúp, đối tác vui lòng gửi RequestID này để được hỗ trợ.
  • Vui lòng bỏ qua các thông tin khác có trong dữ liệu trả về nhưng không được mô tả trong tài liệu.

Thông tin cần lưu ý khác

  • Định dạng ngày trong request, response là: ddMMyyyy (ngày tháng năm)
    Ví dụ: 31122025 (31 tháng 12 năm 2025)
  • Định dạng ngày + giờ trong request, response là ddMMyyyy HHmm (ngày tháng năm giờ phút)
    Ví dụ: 31122025 1830 (31 tháng 12 năm 2025, 18 giờ 30 phút)
  • Một vài trường thông tin kiểu ngày, giờ vẫn có thể xuất hiện trong request, response. Các trường này sẽ được mô tả cụ thể trong đặc tả từng tính năng.
  • Các mã dữ liệu: Bạn cần nắm được các bảng mã dữ liệu liên quan đến nghiệp vụ hàng không để tích hợp API. Trong trường hợp cần cung cấp các bảng mã này, vui lòng liên hệ để được trợ giúp. Ví dụ:
    Loại mã
    Mô tả
    Ví dụ
    Airport
    Mã sân bay
    Mã 3 ký tự theo chuẩn IATA
    		 HAN: Nội Bài
    SGN: Tân Sơn Nhất
    City
    Mã thành phố
    Mã 3 ký tự theo chuẩn IATA
    HAN: Hà Nội
    PAR: Paris
    Country
    Mã quốc gia
    Mã 2 ký tự theo chuẩn IATA
    		 VN: Việt Nam
    JP: Nhật Bản
    Region
    Mã khu vực
    Mã 2 ký tự
    VN: Việt Nam
    ER: Châu Âu
    Airline
    Mã hãng hàng không
    Mã 2 ký tự theo chuẩn IATA
    VN: Vietnam Airlines
    AF: Air France
    Aircraft
    Mã loại máy bay
    Mã 3 ký tự theo chuẩn IATA
    321: Airbus A321
    747: Boeing 747
    Currency
    Mã đơn vị tiền tệ
    Mã 3 ký tự theo chuẩn ISO 4217
    VND: Vietnam Dong
    USD: US Dollar

     

    Luồng sử dụng API cơ bản: