API tutorials

Bizfly Cloud hỗ trợ người dùng quản lý tài nguyên trên Bizfly Cloud thông qua Restful API. Để sử dụng được các API, người dùng cần xác thực để lấy token và sử dụng token này trong header của request tới API.

Hiện Bizfly Cloud hỗ trợ 2 phương thức xác thực:

  • Sử dụng username và password: đây là phương thức xác thực sử dụng username và password của tài khoản đăng ký với Bizfly Cloud

  • Sử dụng Application Credential: đây là phương thức sử dụng cặp ID và Secret của Application Credential. Người dùng có thể tạo ra nhiều cặp ID và Secret với thời gian Expire tương ứng.

Lấy token

Để lấy token, ta sủ dụng endpoint Authentication của Bizfly Cloud. Token này sẽ bị hết hạn trong vòng 4 giờ từ khi khởi tạo.

Endpoint: https://manage.bizflycloud.vn/api/token Phương thức: POST Body gồm các trường sau

  • auth_method: phương thức xác thực, hỗ trợ password và application_credential
  • username: Username khi sử dụng phương thức xác thực bằng password
  • password: Password của user khi sủ dụng phương thức xác thực bằng password
  • project_name: Tên project muốn lấy token khi sử dụng phương thức xác thực bằng password, mặc định sẽ lấy project default
  • project_id: ID của project muốn lấy token khi sử dụng phương thức xác thực bằng password, mặc định sẽ lấy project default
  • application_credential_id: ID của Application Credential khi sử dụng phương thức xác thực application_credential
  • application_credential_secret: Secret của Application Credential khi sử dụng phương thức xác thực application_credential
Sử dụng phương thức xác thực bằng password

Ví dụ bằng cURL như sau

curl --location --request POST 'https://manage.bizflycloud.vn/api/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth_method": "password",
    "username": "sapd@vccloud.vn",
    "password": "hide_password"
}'

Response trả về như sau

{
  "expire_at": "2021-01-31T07:32:19.000000Z",
  "token": "gAAAAABgFiTDWwaL9R0j2wWEVwPW98u3_j_8DWLK0C422aQJjR-qM-twLsaH12VIFMqwQTIY4v7VOEMq2Cs8BJsYPbjaa2w4qqrsZo6kqF0fEmiAKNzOgfLJDJxXKtgPqKf7zZEcDjA7ceZGJuMY5wO2WW_i2ikUfR4gU8FiblaWj7Fj"
}
Sử dụng phương thức xác thực bằng application credential

Ví dụ bằng cURL như sau

curl --location --request POST 'https://manage.bizflycloud.vn/api/token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth_method": "application_credential",
    "credential_id": "8b4f3560e76d448c93efc3bb289149ef",
    "credential_secret": "XeUmeF8-zoYNVu_h9DUtTqaoGXAjxkax0eUai5P-mxpQqsj61cMdzcCfIiu19jEYy8rtOx35V7zoPz20bOItRw"
}'

Response tương ứng như sau

{
  "expire_at": "2021-01-31T07:41:52.000000Z",
  "token": "gAAAAABgFicAtTVZ4-2QVUxuowaKLDD7CGBe5fMsG5ISN5r7cvLhQAfB7Z9RaGbGgRvcGfY5qzxPr_aSRtbg2P9t7obroeuhXOOkuGSxpdfbVOYejOITp7A_xk2RJmZO5Js-yZAJmk5cnVUCc1FfP-LRRK6FyVLHx4shiogldyY95pUxWvV8z-jIQBw0_iqZ2Gs"
}

Cách sử dụng token để tương tác với API

Sau khi lấy được token, người dùng có thể sử dụng token này để tương tác với API của Bizfly Cloud. Người dùng cần đính kèm Token (header: X-Auth-Token) và Tenant Name (tương ứng với username) (header: X-Tenant-Name) vào header trong mỗi request.

Ví dụ để lấy danh sách server tại region Hà Nội ta sử dụng như sau:

curl --location --request GET 'https://hn.manage.bizflycloud.vn/iaas-cloud/api/servers' \
--header 'X-Auth-Token: gAAAAABgFicAtTVZ4-2QVUxuowaKLDD7CGBe5fMsG5ISN5r7cvLhQAfB7Z9RaGbGgRvcGfY5qzxPr_aSRtbg2P9t7obroeuhXOOkuGSxpdfbVOYejOITp7A_xk2RJmZO5Js-yZAJmk5cnVUCc1FfP-LRRK6FyVLHx4shiogldyY95pUxWvV8z-jIQBw0_iqZ2GsI' \
--header 'X-Tenant-Name: sapd@vccloud.vn'

Tài liệu về API theo các dịch vụ

Bizfly Cloud Server
Bizfly Load Balancer
APIs & CLIs bizflyctl CLI