คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X ข้อมูล
เกริ่นนำ
คุณต้องเพิ่มข้อกำหนดและเงื่อนไข ("ข้อกำหนดและเงื่อนไข") ลงในโปรไฟล์องค์กรก่อนเผยแพร่แพ็กเกจราคา ข้อกำหนดและเงื่อนไขอยู่นอกโปรไฟล์องค์กร ในโปรไฟล์องค์กร คุณจะระบุตำแหน่ง (URL สาธารณะ) ของข้อกำหนดและเงื่อนไขได้
หลังจากเผยแพร่แพ็กเกจราคา ข้อกำหนดและเงื่อนไขเวอร์ชันปัจจุบันจะแสดงในพอร์ทัลนักพัฒนาแอป นักพัฒนาแอปจะซื้อแพ็กเกจได้หลังจากยอมรับข้อกำหนดในการให้บริการปัจจุบันแล้วเท่านั้น
การเพิ่มข้อกำหนดและเงื่อนไขโดยใช้ UI
- เข้าถึงหน้าโปรไฟล์องค์กรตามที่อธิบายไว้ในการสำรวจหน้าโปรไฟล์องค์กร
- คลิกแก้ไข
- คลิกเพิ่มข้อกำหนดและเงื่อนไขในส่วนข้อกำหนดและเงื่อนไขของหน้าโปรไฟล์องค์กร
กล่องโต้ตอบข้อกำหนดและเงื่อนไขใหม่ปรากฏขึ้น
- ป้อนข้อมูลต่อไปนี้
ฟิลด์ คำอธิบาย วันที่มีผล วันที่ที่ข้อกำหนดและเงื่อนไขมีผลบังคับใช้ ค่าเริ่มต้นคือวันที่ปัจจุบัน คุณต้องป้อนวันที่ปัจจุบันหรือวันที่ในอนาคต
เวอร์ชัน เวอร์ชันของข้อกำหนดและเงื่อนไข หมายเลขเวอร์ชันช่วยให้คุณติดตามข้อกำหนดและเงื่อนไขเวอร์ชันต่างๆ ได้
URL URL ของข้อกำหนดและเงื่อนไข
- คลิกสร้าง
ระบบจะเพิ่มข้อกำหนดและเงื่อนไขใหม่ลงในส่วนข้อกำหนดและเงื่อนไขของหน้าโปรไฟล์องค์กร
- ทำขั้นตอนที่ 3 ถึง 5 ซ้ำเพื่อเพิ่มข้อกำหนดและเงื่อนไขเพิ่มเติม
- คลิกบันทึกเพื่อบันทึกการเปลี่ยนแปลงโปรไฟล์องค์กร
การแก้ไขข้อกำหนดในการให้บริการโดยใช้ UI
คุณแก้ไขข้อกำหนดและเงื่อนไขโดยตรงไม่ได้ โดยคุณจะต้องลบข้อกำหนดและเงื่อนไขที่ต้องการแก้ไขออก แล้วจึงเพิ่มรายการข้อกำหนดและเงื่อนไขใหม่แทน
การลบข้อกำหนดและเงื่อนไขโดยใช้ UI
- เข้าถึงหน้าโปรไฟล์องค์กรตามที่อธิบายไว้ในการสำรวจหน้าโปรไฟล์องค์กร
- คลิกแก้ไขในหน้าโปรไฟล์องค์กร
- ในรายการข้อกำหนดและเงื่อนไข ให้วางเคอร์เซอร์เหนือข้อกำหนดและเงื่อนไขที่ต้องการลบ
- คลิก
การจัดการข้อกำหนดในการให้บริการโดยใช้ 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}
คือ
การระบุข้อกำหนดและเงื่อนไข เมื่อทำการอัปเดต คุณต้องระบุการตั้งค่าที่อัปเดตและระบุข้อกำหนดและเงื่อนไขในส่วนเนื้อหาของคำขอ ตัวอย่างเช่น คำขอต่อไปนี้แก้ไขหมายเลขเวอร์ชันสำหรับข้อกำหนดและเงื่อนไข (โดยมีการไฮไลต์พร็อพเพอร์ตี้ที่อัปเดตแล้วในตัวอย่าง)
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
ลบข้อกำหนดและเงื่อนไขโดยส่งคำขอลบไปยัง /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 |
การจัดการข้อกำหนดและเงื่อนไข |
ไม่มีข้อมูล | ไม่ได้ |
ขั้นตอนถัดไป
ดูวิธีเพิ่มสกุลเงินที่รองรับไปยังสกุลเงินที่ตั้งค่าไว้ในตอนแรกสำหรับองค์กรในหัวข้อจัดการสกุลเงินที่รองรับ