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

คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info

บทนำ

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

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

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

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

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

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

ต่อไปนี้เป็นตัวอย่างการตอบกลับ

{
  "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} คือตัวระบุข้อกําหนดและเงื่อนไข เมื่อทำการอัปเดต คุณต้องระบุการตั้งค่าที่อัปเดตและการระบุข้อกำหนดและเงื่อนไขในเนื้อหาคำขอ ตัวอย่างเช่น คำขอต่อไปนี้แก้ไขหมายเลขเวอร์ชันของข้อกำหนดและเงื่อนไข (ระบบจะไฮไลต์พร็อพเพอร์ตี้ที่อัปเดตในตัวอย่าง)

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	องค์กรสำหรับข้อกำหนดและเงื่อนไข	ไม่มี	ไม่

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

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