REST API reference

Xác thực

Bizfly Cloud Business Email API sử dụng các header X-Auth-Token để xác thực API

Lấy danh sách tổ chức

GET https://manage.bizflycloud.vn/mail-inbox/api/v2/organizations

Query string

Name In Required Type Description
page Params False int Paginate
per_page Params False int Paginate
search_text Params False str search string

Ví dụ

curl 'https://manage.bizflycloud.vn/mail-inbox/api/v2/organizations?page=1&per_page=10&search_text=' \
--header 'X-Auth-Token: <token>'

Thêm mới người dùng

POST https://manage.bizflycloud.vn/mail-inbox/api/accounts

Ví dụ

curl 'https://manage.bizflycloud.vn/mail-inbox/api/accounts' \
--header 'X-Auth-Token: <token>' \
--data-raw '{
    "data": {
        "type": "account",
        "attributes": {
            "organization_id": "1",
            "username": "test01",
            "password": "ASDNxcvnjk23@43",
            "type": "Member",
            "gender": "female", 
            "fullname": "Full name",
            "dob": "2023-05-24",
            "phone": "0912345679",
            "groups": "test@bizflycloud.vn,test2@bizflycloud.vn" 
        }
    }
}'

Request Body

  • Tất cả thông tin sẽ trong: data.attributes
Name In Required Type Description
organization_id body True str Id của tổ chức
username body True str Tên tài khoản
password body True str Mật khẩu
type body True str Quyền của user: Admin / Member
gender body True str Giới tính
fullname body True str Họ và tên
dob body False str Ngày sinh
phone body False str Số điện thoại
groups body False str danh sách groups, cách nhau dấu ,

Lấy danh sách người dùng

POST https://manage.bizflycloud.vn/mail-inbox/api/organizations/<organization_id>/members

Request parameters

Name In Required Type Description
organization_id Params False int Id của tổ chức

Query string

Name In Required Type Description
page[number] Params False int Paginate
orgId Params False int Id của tổ chức
filter Params False str tìm kiếm
sort Params False str Sắp xếp: -created

Mô tả filter:

  • Để tìm kiếm theo email có thể dùng theo cách sau: filter=[{“name”:“email”,“op”:“ilike”,“val”:"%%"}]

Ví dụ

curl 'https://manage.bizflycloud.vn/mail-inbox/api/organizations/3248/members?page[number]=1&orgId=3248&sort=-created_at&filter=[{"name":"email","op":"ilike","val":"%test@bizflycloud.vn%"}]' \
--header 'X-Auth-Token: <token>'

Xóa người dùng

DELETE https://manage.bizflycloud.vn/mail-inbox/api/accounts/<account_id>

URI Parameters

Name In Required Type Description
account_id Params True int Id tài khoản muốn xóa

Ví dụ

curl DELETE 'https://manage.bizflycloud.vn/mail-inbox/api/accounts/211073' \
--header 'X-Auth-Token: <token>'

Cập nhật người dùng

curl --location --request PATCH 'https://manage.bizflycloud.vn/mail-inbox/api/accounts/<account_id>' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "type": "account",
        "id": "<account_id>",
        "attributes": {
            "gender": "<gender>",
            "fullname": "<fullname>",
            "dob": "<dob>",
            "phone": "<phone>",
            "active": <active>,
        }
    }
}'

URI Parameters

Name In Required Type Description
account_id Params True int Id tài khoản muốn xóa
dob Params False string Ngày tháng năm sinh
fullname Params False string Họ và tên
gender Params False string Giới tính
phone Params False string Số điện thoại
active Params False bool Trạng thái tài khoản

Ví dụ

curl --location --request PATCH 'https://manage.bizflycloud.vn/mail-inbox/api/accounts/183304' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "type": "account",
        "id": "183304",
        "attributes": {
            "gender": "male",
            "fullname": "Nguyen Van A",
            "dob": "30/12/1994",
            "phone": 0966086471,
            "active": true,
        }
    }
}'
Xác thực DNS Webmail