Quản lý điều khoản và điều kiện

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X.
thông tin

Giới thiệu

Bạn phải thêm các điều khoản và điều kiện ("Điều khoản và điều kiện") vào hồ sơ tổ chức của mình trước khi xuất bản gói giá. Những điều khoản và điều kiện đó không thuộc tổ chức hồ sơ. Trong hồ sơ tổ chức của mình, bạn chỉ định vị trí (URL công khai) của Điều khoản và điều kiện.

Sau khi bạn xuất bản một gói giá, phiên bản hiện tại của các điều khoản và điều kiện sẽ hiển thị trong cổng thông tin dành cho nhà phát triển. Nhà phát triển chỉ có thể mua một gói sau khi chấp nhận gói Điều khoản và điều kiện.

Thêm điều khoản và điều kiện bằng giao diện người dùng

  1. Truy cập vào trang Hồ sơ của tổ chức, như mô tả trong bài viết Khám phá trang Hồ sơ của tổ chức.
  2. Nhấp vào Chỉnh sửa.
  3. Trong phần Điều khoản và điều kiện trên trang Hồ sơ tổ chức, hãy nhấp vào Thêm điều khoản và điều kiện.

    Hộp thoại Điều khoản và điều kiện mới sẽ xuất hiện

  4. Nhập thông tin dưới đây:
    Trường Mô tả
    Ngày hiệu lực

    Ngày các điều khoản và điều kiện có hiệu lực. Mặc định là hiện tại ngày. Bạn phải nhập ngày hiện tại hoặc trong tương lai.

    Phiên bản

    Phiên bản của điều khoản và điều kiện. Số phiên bản này cho phép bạn giữ lại theo dõi các phiên bản khác nhau của điều khoản và điều kiện.

    URL

    URL của điều khoản và điều kiện.

  5. Nhấp vào Tạo.

    Các điều khoản và điều kiện mới sẽ được thêm vào mục Điều khoản và điều kiện trong Hồ sơ của tổ chức .

  6. Lặp lại các bước từ 3 đến 5 để thêm các điều khoản và điều kiện bổ sung.
  7. Nhấp vào Lưu để lưu các thay đổi đối với hồ sơ tổ chức.

Chỉnh sửa điều khoản và điều kiện bằng giao diện người dùng

Bạn không thể chỉnh sửa trực tiếp Điều khoản và điều kiện. Thay vào đó, bạn phải xoá các điều khoản và điều kiện mà bạn muốn chỉnh sửa, rồi thêm mục điều khoản và điều kiện mới.

Xoá điều khoản và điều kiện bằng giao diện người dùng

  1. Truy cập vào trang Hồ sơ của tổ chức, như mô tả trong bài viết Khám phá trang Hồ sơ của tổ chức.
  2. Nhấp vào Chỉnh sửa trên trang Hồ sơ tổ chức.
  3. Trong danh sách các Điều khoản và điều kiện, hãy đặt con trỏ lên các Điều khoản và điều kiện mà bạn muốn xoá.
  4. Nhấp vào .

Quản lý các điều khoản và điều kiện bằng API

Quản lý các điều khoản và điều kiện bằng API, như được mô tả trong các phần sau.

Thêm điều khoản và điều kiện bằng API

Thêm các Điều khoản và Điều kiện bằng cách gửi yêu cầu POST cho /mint/organizations/{org_name}/tncs. Khi thêm các Điều khoản và điều kiện, bạn có thể tuỳ ý chỉ định:

  • URL
  • Văn bản đi kèm (chẳng hạn như nội dung mô tả)
  • Ngày mà các Điều khoản và điều kiện có hiệu lực
  • Số phiên bản

Xem thuộc tính cấu hình Điều khoản và điều kiện để biết thêm thông tin về các lựa chọn này.

Ví dụ:

curl -X POST   "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "url":"www.testoperator/termsandconditions",
     "tncText":"Sample text for the T&C",
     "version":"1.1",
     "startDate":"2018-09-24"
  }' \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
   "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
   "organization" : {     
     …
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.1"
 }

Xem điều khoản và điều kiện bằng API

Xem các Điều khoản và Điều kiện cụ thể hoặc tất cả các Điều khoản và Điều kiện của một tổ chức.

Xem sản phẩm cụ thể Các điều khoản và điều kiện bằng cách gửi yêu cầu GET tới /mint/organizations/{org_name}/tncs/{tncs_id}, trong đó {tncs_id} là thông tin nhận dạng các Điều khoản và Điều kiện cụ thể (mã nhận dạng được trả về trong khi tạo Điều khoản và điều kiện). Ví dụ:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

Xem tất cả các Điều khoản và Điều kiện của tổ chức bằng cách gửi yêu cầu GET tới /mint/organizations/{org_name}/tncs. Ví dụ:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Accept: application/json" \
  -u email:password

Sau đây là ví dụ về phản hồi:

{

"tnc" : [
  {
    "id" : "77193339-8d79-44a8-8af2-3593f16c158e",
    "organization" :
    {
      ...
    },
   "startDate" : "2018-07-01 00:00:00",
   "tncText" : "Big operator text for the T&C",
   "url" : "www.bigoperator/termsandconditions",
   "version" : "1.0"
  },
  {
    "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
    "organization" : {
    ...
  },
    "startDate" : "2018-09-24 00:00:00",
    "tncText" : "Sample text for the T&C",
    "url" : "www.testoperator/termsandconditions",
    "version" : "1.1"
  }
  ]
   "totalRecords" : 2
}

Chấp nhận tài liệu về điều khoản và điều kiện của nhà phát triển hoặc công ty bằng API

Chấp nhận tài liệu về Điều khoản và điều kiện của một nhà phát triển hoặc công ty cụ thể bằng cách phát hành một yêu cầu POST yêu cầu một trong các API sau, tương ứng:

  • /mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

Trong đó {dev_id} là mã nhà phát triển (địa chỉ email), {company_id} là mã công ty và {tncs_id} là mã tài liệu điều khoản và điều kiện.

Ví dụ:

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
  -H "Content-Type: application/json" \
  -d \
  '{
     "action":"ACCEPTED",
     "auditDate":"2018-10-01 00:00:00"
  }' \
  -u email:password

Sau đây là ví dụ về phản hồi:

Lưu ý: Trong tải trọng phản hồi, auditDate được đặt thành thời gian hiện tại theo giờ UTC.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Xem điều khoản và điều kiện được chấp nhận bởi nhà phát triển hoặc công ty bằng API

Xem các Điều khoản và điều kiện đã được một nhà phát triển hoặc công ty cụ thể chấp nhận bằng cách cấp một GET yêu cầu một trong các API sau, tương ứng:

  • /mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/developer-tncs

Trong đó {dev_id} là mã nhà phát triển (địa chỉ email) và {company_id} là mã công ty.

Ví dụ:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
  -H "Accept:application/json"  \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

Chỉnh sửa điều khoản và điều kiện bằng API

Chỉnh sửa Điều khoản và điều kiện bằng cách gửi yêu cầu PUT cho /mint/organizations/{org_named}/tncs/{tncs_id}, trong đó {tncs_id} là để nhận dạng các Điều khoản và điều kiện. Khi cập nhật, bạn cần nêu rõ trong yêu cầu đưa ra nội dung các cài đặt đã cập nhật và nhận dạng các Điều khoản và điều kiện. Ví dụ: như sau yêu cầu chỉnh sửa số phiên bản cho các Điều khoản và điều kiện (thuộc tính được cập nhật được đánh dấu trong ví dụ):

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
  -H "Content-Type: application/json" \
  -d {
    "id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
    "version":"1.2"
  }' \
  -u email:password

Sau đây là ví dụ về phản hồi:

{
   "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9",
   "organization" : {
       "address" : [ {
       "address1" : "Test address",
       "city" : "Test City",
       "country" : "US",
       "id" : "test-address",
       "isPrimary" : true,
       "state" : "CA",
       "zip" : "54321"
     } ],
     "
   },
   "startDate" : "2018-09-24 00:00:00",
   "tncText" : "Sample text for the T&C",
   "url" : "www.testoperator/termsandconditions",
   "version" : "1.2"
 }

Xoá điều khoản và điều kiện bằng API

Xoá các Điều khoản và điều kiện bằng cách gửi yêu cầu DELETE cho /mint/organizations/{org_name}/tncs/{tncs_id}, trong đó {tncs_id} là để nhận dạng các Điều khoản và điều kiện. Ví dụ:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
  -H "Accept: application/json"  \
  -u email:password

Thuộc tính cấu hình điều khoản và điều kiện cho API

Bảng sau đây tóm tắt các thuộc tính cấu hình có thể được thiết lập bằng API cho các điều khoản và điều kiện.

Tên Mô tả Mặc định Bắt buộc?
url

URL của các Điều khoản và Điều kiện.

Không áp dụng Không
tncText

Văn bản (chẳng hạn như nội dung mô tả ngắn) cho các Điều khoản và điều kiện.

Không áp dụng Không
version

Phiên bản của Điều khoản và điều kiện. Số phiên bản này cho phép bạn theo dõi các các phiên bản của Điều khoản và điều kiện.

Không áp dụng
startDate

Ngày các Điều khoản và điều kiện có hiệu lực.

Không áp dụng
organization

Tổ chức thực hiện các Điều khoản và Điều kiện.

Không áp dụng Không

Các bước tiếp theo

Tìm hiểu cách thêm đơn vị tiền tệ được hỗ trợ vào những đơn vị tiền tệ được thiết lập ban đầu cho tổ chức của bạn trong Quản lý các tính năng được hỗ trợ đơn vị tiền tệ.