จัดการข้อกำหนดและเงื่อนไข

คุณกำลังดูเอกสารประกอบ Apigee Edge
ไปที่ เอกสารประกอบเกี่ยวกับ Apigee X. ข้อมูล

บทนำ

คุณต้องเพิ่มข้อกำหนดและเงื่อนไข ("ข้อกำหนดและเงื่อนไข") ในโปรไฟล์องค์กรก่อนที่จะเผยแพร่แพ็กเกจราคา ข้อกำหนดและเงื่อนไขอยู่ภายนอกองค์กร โปรไฟล์ ในโปรไฟล์องค์กร คุณต้องระบุตำแหน่ง (URL สาธารณะ) ของ ข้อกำหนดและเงื่อนไข

หลังจากเผยแพร่แพ็กเกจราคาแล้ว ข้อกำหนดและเงื่อนไขเวอร์ชันปัจจุบันจะแสดงใน พอร์ทัลนักพัฒนาซอฟต์แวร์ นักพัฒนาแอปสามารถซื้อแพ็กเกจได้หลังจากยอมรับแพ็กเกจปัจจุบันแล้วเท่านั้น ข้อกำหนดและเงื่อนไข

การเพิ่มข้อกำหนดและเงื่อนไขโดยใช้ UI

  1. เข้าถึงหน้าโปรไฟล์องค์กรตามที่อธิบายไว้ในการสำรวจหน้าโปรไฟล์องค์กร
  2. คลิกแก้ไข
  3. ในส่วนข้อกำหนดในการให้บริการของหน้าโปรไฟล์องค์กร ให้คลิกเพิ่มข้อกำหนดและ ของ Google

    กล่องโต้ตอบข้อกำหนดในการให้บริการใหม่จะปรากฏขึ้น

  4. ป้อนข้อมูลต่อไปนี้
    ช่อง คำอธิบาย
    วันที่มีผล

    วันที่ที่ข้อกำหนดและเงื่อนไขมีผลบังคับใช้ ค่าเริ่มต้นคือปัจจุบัน วันที่ คุณต้องป้อนวันที่ปัจจุบันหรือวันที่ในอนาคต
    เวอร์ชัน

    เวอร์ชันของข้อกำหนดและเงื่อนไข หมายเลขเวอร์ชันช่วยให้คุณเก็บ ติดตามข้อกำหนดในการให้บริการเวอร์ชันต่างๆ
    URL

    URL ของข้อกำหนดและเงื่อนไข
  5. คลิกสร้าง

    ข้อกำหนดและเงื่อนไขใหม่จะเพิ่มไปยังส่วนข้อกำหนดและเงื่อนไขของโปรไฟล์องค์กร

  6. ทำขั้นตอนที่ 3 ถึง 5 ซ้ำเพื่อเพิ่มข้อกำหนดและเงื่อนไขเพิ่มเติม
  7. คลิกบันทึกเพื่อบันทึกการเปลี่ยนแปลงโปรไฟล์องค์กร

การแก้ไขข้อกำหนดในการให้บริการโดยใช้ UI

คุณไม่สามารถแก้ไขข้อกำหนดในการให้บริการได้โดยตรง คุณจะต้องลบข้อกำหนดและเงื่อนไขแทน ที่คุณต้องการแก้ไข จากนั้นเพิ่มรายการข้อกำหนดในการให้บริการใหม่

การลบข้อกำหนดในการให้บริการโดยใช้ UI

  1. เข้าถึงหน้าโปรไฟล์องค์กรตามที่อธิบายไว้ในการสำรวจหน้าโปรไฟล์องค์กร
  2. คลิกแก้ไขบนหน้าโปรไฟล์องค์กร
  3. ในรายการข้อกำหนดและเงื่อนไข ให้วางเคอร์เซอร์เหนือข้อกำหนดและเงื่อนไขที่ต้องการลบ
  4. คลิก

การจัดการข้อกำหนดในการให้บริการโดยใช้ API

จัดการข้อกำหนดและเงื่อนไขโดยใช้ API ดังที่อธิบายไว้ในส่วนต่อไปนี้

การเพิ่มข้อกำหนดและเงื่อนไขโดยใช้ API

เพิ่มข้อกำหนดและเงื่อนไขโดยการส่งคำขอ POST ไปยัง /mint/organizations/{org_name}/tncs เมื่อเพิ่มข้อกำหนดและเงื่อนไข คุณจะระบุหรือไม่ก็ได้

  • URL
  • ข้อความประกอบ (เช่น คำอธิบาย)
  • วันที่ที่ข้อกำหนดและเงื่อนไขมีผลบังคับใช้
  • หมายเลขเวอร์ชัน

ดูพร็อพเพอร์ตี้การกำหนดค่าข้อกำหนดและเงื่อนไขสำหรับข้อมูลเพิ่มเติม ข้อมูลเกี่ยวกับตัวเลือกเหล่านี้

เช่น

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

ตัวอย่างคําตอบมีดังนี้

{
   "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"
 }

การดูข้อกำหนดในการให้บริการโดยใช้ API

ดูข้อกำหนดและเงื่อนไขเฉพาะหรือข้อกำหนดและเงื่อนไขทั้งหมดสำหรับองค์กร

ดูรายการที่เฉพาะเจาะจง ข้อกำหนดและเงื่อนไขโดยการส่งคำขอ GET ไปยัง /mint/organizations/{org_name}/tncs/{tncs_id} โดยที่ {tncs_id} คือการระบุข้อกำหนดและเงื่อนไขที่เฉพาะเจาะจง (ระบบจะส่งคืนรหัสใน เมื่อสร้างข้อกำหนดและเงื่อนไข) เช่น

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

ดูข้อกำหนดและเงื่อนไขทั้งหมดสำหรับองค์กรโดยการส่งคำขอ GET เพื่อ /mint/organizations/{org_name}/tncs เช่น

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

ตัวอย่างคําตอบมีดังนี้

{

"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
}

การยอมรับข้อกำหนดและเงื่อนไขสำหรับนักพัฒนาหรือบริษัทโดยใช้ API

ยอมรับเอกสารข้อกำหนดและเงื่อนไขสำหรับนักพัฒนาแอปหรือบริษัทที่เจาะจงโดยออก POST คำขอไปยัง API รายการใดรายการหนึ่งต่อไปนี้ตามลำดับ

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

โดยที่ {dev_id} คือรหัสนักพัฒนาแอป (อีเมล) {company_id} คือรหัสบริษัท และ {tncs_id} คือรหัสเอกสารข้อกำหนดและเงื่อนไข

เช่น

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

ตัวอย่างคําตอบมีดังนี้

หมายเหตุ: ในเพย์โหลดการตอบกลับ ระบบจะตั้งค่า auditDate เป็นเวลาปัจจุบันในเขตเวลา UTC
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

การดูข้อกำหนดในการให้บริการที่นักพัฒนาซอฟต์แวร์หรือบริษัทยอมรับโดยใช้ API

ดูข้อกำหนดและเงื่อนไขที่นักพัฒนาซอฟต์แวร์หรือบริษัทหนึ่งๆ ยอมรับโดยการออก GET คำขอไปยัง API รายการใดรายการหนึ่งต่อไปนี้ตามลำดับ

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

โดยที่ {dev_id} คือรหัสนักพัฒนาซอฟต์แวร์ (อีเมล) และ {company_id} คือรหัสบริษัท

เช่น

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

ตัวอย่างคําตอบมีดังนี้

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

การแก้ไขข้อกำหนดและเงื่อนไขโดยใช้ API

แก้ไขข้อกำหนดและเงื่อนไขโดยการส่งคำขอ PUT ไปยัง /mint/organizations/{org_named}/tncs/{tncs_id} โดยที่ {tncs_id} คือค่า ของข้อกำหนดและเงื่อนไข เมื่อคุณทำการอัปเดต คุณต้องระบุในคำขอ เนื้อหาของการตั้งค่าที่อัปเดตและการระบุข้อกำหนดและเงื่อนไข ตัวอย่างเช่น URL ต่อไปนี้ ขอให้แก้ไขหมายเลขเวอร์ชันของข้อกำหนดและเงื่อนไข (ระบบจะไฮไลต์พร็อพเพอร์ตี้ที่อัปเดตแล้วใน ตัวอย่าง)

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

ตัวอย่างคําตอบมีดังนี้

{
   "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"
 }

การลบข้อกำหนดและเงื่อนไขโดยใช้ API

ลบข้อกำหนดและเงื่อนไขโดยการส่งคำขอ DELETE ไปยัง /mint/organizations/{org_name}/tncs/{tncs_id} โดยที่ {tncs_id} คือค่า ของข้อกำหนดและเงื่อนไข เช่น

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

พร็อพเพอร์ตี้การกำหนดค่าข้อกำหนดและเงื่อนไขของ API

ตารางต่อไปนี้สรุปพร็อพเพอร์ตี้การกําหนดค่าที่ตั้งค่าได้โดยใช้ API สําหรับข้อกําหนดและเงื่อนไข

ชื่อ คำอธิบาย ค่าเริ่มต้น จำเป็นหรือไม่
url

URL ของข้อกำหนดและเงื่อนไข

 ไม่มี ไม่ได้
tncText

ข้อความ (เช่น คำอธิบายสั้นๆ) สำหรับข้อกำหนดและเงื่อนไข

 ไม่มี ไม่ได้
version

เวอร์ชันของข้อกำหนดและเงื่อนไข หมายเลขเวอร์ชันช่วยให้คุณสามารถติดตาม ของข้อกำหนดและเงื่อนไข

 ไม่มี ใช่
startDate

วันที่ที่ข้อกำหนดและเงื่อนไขมีผลบังคับใช้

 ไม่มี ใช่
organization

องค์กรสำหรับข้อกำหนดและเงื่อนไข

 ไม่มี ไม่ได้

ขั้นตอนถัดไป

ดูวิธีเพิ่มสกุลเงินที่รองรับไปยังสกุลเงินที่ตั้งค่าไว้ในตอนแรกสำหรับองค์กรของคุณใน จัดการรายการที่รองรับ สกุลเงิน