การกําหนดค่าการลงทะเบียนแอป

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

นักพัฒนาแอปจะใช้หน้า "แอปของฉัน" ในพอร์ทัลบริการสำหรับนักพัฒนาแอปเพื่อลงทะเบียนแอป นักพัฒนาแอปเข้าถึงหน้า "แอปของฉัน" จากเมนูหลักของพอร์ทัลได้ดังนี้

ในการลงทะเบียนแอปใหม่ นักพัฒนาแอปจะเลือกปุ่ม "เพิ่มแอปใหม่" ในหน้า "แอปของฉัน"

จากนั้นพอร์ทัลจะแสดงแบบฟอร์มการลงทะเบียนแอปเริ่มต้น ดังนี้

โดยค่าเริ่มต้น นักพัฒนาแอปจะต้องระบุชื่อแอป, URL เรียกกลับ และรายการผลิตภัณฑ์ API ที่จะเพิ่มในแอปเท่านั้น

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

  • รายการผลิตภัณฑ์ API ที่ใช้ได้ในพอร์ทัล
  • มีผลิตภัณฑ์ API เริ่มต้นหรือไม่
  • ต้องระบุ URL เรียกกลับหรือไม่
  • กำหนดว่าคีย์ API เป็นคีย์ API ได้รับการอนุมัติด้วยตนเองหรือโดยอัตโนมัติสำหรับผลิตภัณฑ์ API
  • จำเป็นต้องมีข้อมูลอื่นๆ ในหน้าเพิ่มแอปเพื่อลงทะเบียนแอปหรือไม่

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

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

การระบุผลิตภัณฑ์ API ที่พร้อมจำหน่ายในพอร์ทัล

คุณระบุผลิตภัณฑ์ API ที่จะพร้อมใช้งานเมื่อนักพัฒนาซอฟต์แวร์เข้าถึงพอร์ทัลได้ 2 วิธี ดังนี้

การระบุระดับการเข้าถึงเมื่อสร้างผลิตภัณฑ์ API

เมื่อสร้างผลิตภัณฑ์ API คุณจะต้องระบุตัวเลือกระดับการเข้าถึงของผลิตภัณฑ์ตามที่แสดงด้านล่าง

ดูข้อมูลเพิ่มเติมเกี่ยวกับผลกระทบที่ระดับการเข้าถึงมีต่อความพร้อมใช้งานของผลิตภัณฑ์ API ในพอร์ทัลนักพัฒนาซอฟต์แวร์ Drupal 7 ได้ที่ระดับการเข้าถึง

การจำกัดการเข้าถึงผลิตภัณฑ์ API ตามบทบาท

เมื่อเปิดใช้โมดูล Drupal การเข้าถึงบทบาทของผลิตภัณฑ์ API คุณจะระบุบทบาทที่เข้าถึงผลิตภัณฑ์ API แต่ละรายการได้

หากต้องการจำกัดการเข้าถึงผลิตภัณฑ์ API ตามบทบาทนักพัฒนาซอฟต์แวร์ ให้ทำดังนี้

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. ตรวจสอบบทบาทพอร์ทัลนักพัฒนาซอฟต์แวร์และการมอบหมายผู้ใช้
    • เลือกบุคคล > สิทธิ์ > บทบาทในเมนูการดูแลระบบ Drupal แล้วเพิ่มหรือแก้ไขบทบาทและสิทธิ์ของนักพัฒนาซอฟต์แวร์ตามที่จำเป็น
    • เลือกบุคคลในเมนูการดูแลระบบ Drupal และแก้ไขการมอบหมายผู้ใช้และบทบาทตามที่จำเป็น
  3. เลือกการกำหนดค่า > พอร์ทัลที่กำลังพัฒนา > การเข้าถึงบทบาทผลิตภัณฑ์ API ในเมนูการดูแลระบบ Drupal
  4. เลือกบทบาทที่คุณต้องการให้เข้าถึงผลิตภัณฑ์ API แต่ละรายการได้
  5. คลิก Save Configuration

กำหนดค่าวิธีที่นักพัฒนาแอปเชื่อมโยงผลิตภัณฑ์ API กับแอป

ในการลงทะเบียนแอปใหม่ นักพัฒนาแอปเลือกปุ่ม "เพิ่มแอปใหม่" ในหน้า "แอปของฉัน" เพื่อเปิดแบบฟอร์ม "เพิ่มแอป"

นักพัฒนาแอปสามารถเลือกผลิตภัณฑ์ API อย่างน้อย 1 รายการเพื่อเชื่อมโยงกับแอปได้ในขณะที่ลงทะเบียนแอป ทั้งนี้ขึ้นอยู่กับวิธีที่คุณกำหนดค่าพอร์ทัล หรือจะระบุผลิตภัณฑ์เริ่มต้นที่กำหนดให้กับแอปทั้งหมดก็ได้

ตัวเลือกการกำหนดค่าต่อไปนี้มีอยู่ในพอร์ทัลเพื่อควบคุมการเลือกผลิตภัณฑ์ API เมื่อลงทะเบียนแอป

  • อย่าเชื่อมโยงแอปกับผลิตภัณฑ์ API ใดๆ
  • เชื่อมโยงแอปทั้งหมดกับผลิตภัณฑ์ API เริ่มต้นอย่างน้อย 1 รายการ (กำหนดค่าด้านล่าง) นักพัฒนาซอฟต์แวร์จะเพิ่มผลิตภัณฑ์ API อื่นๆ ลงในแอปไม่ได้
  • อนุญาตให้เลือกผลิตภัณฑ์ API รายการเดียว แต่ไม่บังคับ
  • ต้องเลือกผลิตภัณฑ์ API รายการเดียว
  • อนุญาตให้เลือกผลิตภัณฑ์ API หลายรายการ แต่ไม่บังคับ
  • อนุญาตให้เลือกผลิตภัณฑ์ API หลายรายการและต้องมีอย่างน้อย 1 รายการ

คุณควบคุมองค์ประกอบ HTML ที่ปรากฏในแบบฟอร์มที่นักพัฒนาแอปใช้ในการเลือกผลิตภัณฑ์ API ได้ด้วย โดยมีตัวเลือกดังนี้

  • รายการแบบเลื่อนลง
  • ช่องทำเครื่องหมายหรือปุ่มตัวเลือก ช่องทำเครื่องหมายจะปรากฏขึ้นเมื่อนักพัฒนาแอปเลือกผลิตภัณฑ์ API ได้หลายรายการ และปุ่มตัวเลือกจะปรากฏขึ้นเมื่อนักพัฒนาแอปเลือกผลิตภัณฑ์ API ได้เพียงผลิตภัณฑ์เดียวเท่านั้น

วิธีตั้งค่าตัวเลือกสำหรับการเลือกผลิตภัณฑ์ API

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. เลือก การกำหนดค่า > การตั้งค่าพอร์ทัลนักพัฒนาซอฟต์แวร์ > การตั้งค่าแอปพลิเคชัน ในเมนูการดูแลระบบ Drupal
  3. ในหน้าการตั้งค่าแอปพลิเคชัน ให้ขยายพื้นที่การตั้งค่าผลิตภัณฑ์ API
  4. ในส่วนการจัดการผลิตภัณฑ์ API ให้เลือกตัวเลือกที่ควบคุมการเลือกผลิตภัณฑ์ API
  5. หากคุณระบุตัวเลือก "เชื่อมโยงแอปทั้งหมดกับผลิตภัณฑ์ API เริ่มต้นอย่างน้อย 1 รายการ (กำหนดค่าด้านล่าง)" ให้ตั้งค่าผลิตภัณฑ์เริ่มต้นในส่วนผลิตภัณฑ์ API เริ่มต้น
  6. ในส่วนวิดเจ็ตผลิตภัณฑ์ API ให้เลือกองค์ประกอบ HTML ที่นักพัฒนาซอฟต์แวร์ใช้เพื่อเลือกผลิตภัณฑ์ API
  7. บันทึกการกำหนดค่า

การกำหนดค่าการจัดการ URL เรียกกลับ

หากพร็อกซี API ในผลิตภัณฑ์ API ใช้ "OAuth แบบ 3 ทาง" (ประเภทการให้สิทธิ์รหัสการให้สิทธิ์) นักพัฒนาซอฟต์แวร์ต้องระบุ URL เรียกกลับเมื่อลงทะเบียนแอป โดยปกติแล้ว URL เรียกกลับจะระบุ URL ของแอปที่กำหนดให้รับรหัสการให้สิทธิ์ในนามของแอปไคลเอ็นต์ นอกจากนี้ จะใช้สตริง URL สำหรับการตรวจสอบความถูกต้องด้วย ไคลเอ็นต์ต้องส่ง URL นี้ไปยัง Apigee Edge เมื่อขอรหัสการให้สิทธิ์และโทเค็นเพื่อการเข้าถึง และพารามิเตอร์ redirect_uri ต้องตรงกับ URL ที่ได้ลงทะเบียนไว้ ดูข้อมูลเพิ่มเติมได้ที่การใช้ประเภทการให้สิทธิ์รหัสการให้สิทธิ์

วิธีควบคุม URL เรียกกลับสำหรับการเลือกผลิตภัณฑ์ API

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. เลือกการกำหนดค่า > การตั้งค่าพอร์ทัลนักพัฒนาซอฟต์แวร์ > แอตทริบิวต์ของแอปพลิเคชันในเมนูการดูแลระบบ Drupal
  3. ในหน้าการตั้งค่าแอปพลิเคชัน ให้ขยายพื้นที่การตั้งค่า URL เรียกกลับ
  4. ในส่วนการจัดการ URL เรียกกลับ ให้เลือกตัวเลือกใดตัวเลือกหนึ่งต่อไปนี้
    • แอปนักพัฒนาแอปทั้งหมดต้องมี URL เรียกกลับ
    • แอปนักพัฒนาซอฟต์แวร์ทั้งหมดจะระบุ URL เรียกกลับหรือไม่ก็ได้
    • ไม่จำเป็นต้องมีหรือมีการแสดง URL เรียกกลับ
  5. บันทึกการกำหนดค่า

การแสดงข้อมูลวิเคราะห์สําหรับการใช้งานแอป

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

  • อัตราการส่งข้อมูล
  • เวลาตอบสนองสูงสุด
  • เวลาตอบสนองต่ำสุด
  • จำนวนข้อความ
  • จำนวนข้อผิดพลาด

วิธีเปิดใช้ข้อมูลวิเคราะห์ในพอร์ทัล

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. เลือกการกำหนดค่า > พอร์ทัลการพัฒนา > การตั้งค่าแอปพลิเคชันในเมนูการดูแลระบบ Drupal
  3. ในหน้าการตั้งค่าแอปพลิเคชัน ให้ขยายพื้นที่การตั้งค่าประสิทธิภาพของแอป
  4. เลือกช่องทำเครื่องหมายแสดงแท็บการวิเคราะห์แอปสำหรับนักพัฒนาซอฟต์แวร์
  5. เลือกทดสอบหรือเวอร์ชันที่ใช้งานจริงสำหรับสภาพแวดล้อมเพื่อค้นหาข้อมูลการวิเคราะห์ สำหรับพอร์ทัลที่พร้อมใช้งานแบบสาธารณะ โดยทั่วไปคุณจะเลือกเวอร์ชันที่ใช้งานจริง
  6. บันทึกการกำหนดค่า

วิธีแสดงข้อมูลวิเคราะห์ในพอร์ทัลสำหรับแอป

  1. เลือกชื่อแอปในหน้า "แอปของฉัน"
  2. เลือกลิงก์ Analytics สำหรับแอป
  3. เลือกประเภทของข้อมูลวิเคราะห์ที่จะแสดงและช่วงวันที่
  4. ข้อมูลที่เลือกจะปรากฏขึ้น:

การอนุมัติหรือเพิกถอนคีย์ API สำหรับผลิตภัณฑ์ API ด้วยตนเอง

เมื่อนักพัฒนาซอฟต์แวร์เพิ่มผลิตภัณฑ์ API ลงในแอปแล้วลงทะเบียนแอป พอร์ทัลจะส่งคีย์ API ของแอปกลับไปให้นักพัฒนาซอฟต์แวร์ จากนั้นนักพัฒนาจะใช้คีย์ API นั้นเพื่อเข้าถึงพร็อกซี API ที่รวมโดยผลิตภัณฑ์ API ที่เชื่อมโยงกับแอป

คุณควบคุมกระบวนการอนุมัติคีย์สำหรับผลิตภัณฑ์ API แต่ละรายการเมื่อสร้างผลิตภัณฑ์ API ได้ดังนี้

ขั้นตอนการอนุมัติมีดังนี้

  • อัตโนมัติ - พอร์ทัลสำหรับผลิตภัณฑ์ API จะส่งคืนคีย์ API ที่ได้รับอนุมัติเมื่อนักพัฒนาแอปลงทะเบียนแอป คุณเพิกถอนคีย์ที่ได้รับอนุมัติโดยอัตโนมัติในภายหลังได้
  • ด้วยตนเอง - พอร์ทัลจะส่งคีย์ API กลับมาเมื่อนักพัฒนาแอปลงทะเบียนแอป แต่ไม่ได้เปิดใช้งานคีย์สำหรับผลิตภัณฑ์ API ที่ใช้การอนุมัติคีย์ด้วยตนเอง ผู้ดูแลระบบต้องอนุมัติคีย์ API ด้วยตนเองใน UI การจัดการ Edge หรือ API ก่อนที่นักพัฒนาซอฟต์แวร์จะใช้คีย์ดังกล่าวเพื่อเข้าถึงผลิตภัณฑ์ API ได้ คุณเพิกถอนคีย์ที่อนุมัติด้วยตนเองได้ในภายหลัง

ดูสร้างผลิตภัณฑ์ API สำหรับข้อมูลเพิ่มเติม

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

หากต้องการดูรายการผลิตภัณฑ์ API สำหรับแอปและสถานะการอนุมัติคีย์สำหรับผลิตภัณฑ์ API นักพัฒนาซอฟต์แวร์เลือกชื่อแอปในหน้า "แอปของฉัน" จากนั้นเลือกลิงก์ "ผลิตภัณฑ์" ดังนี้

ในตัวอย่างนี้ ผลิตภัณฑ์ Premium Weather API ใช้การอนุมัติด้วยตนเอง และกำลังรอให้ผู้ดูแลระบบอนุมัติคีย์ ผลิตภัณฑ์ API ฟรีใช้การอนุมัติโดยอัตโนมัติและการใช้คีย์เพื่อเข้าถึงผลิตภัณฑ์ได้รับอนุมัติแล้ว

หากต้องการอนุมัติหรือเพิกถอนคีย์ด้วยตนเอง ให้ทำดังนี้

  1. เข้าสู่ระบบ UI การจัดการ Edge ในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบขององค์กร
  2. เลือกแพลตฟอร์ม API ในช่องแบบเลื่อนลงที่มุมขวาบน
  3. เลือกเผยแพร่ > แอปของนักพัฒนาซอฟต์แวร์ เพื่อเปิดรายชื่อแอปของนักพัฒนาซอฟต์แวร์
  4. เลือกปุ่มรอดำเนินการเพื่อดูรายการแอปที่มีคำขอคีย์ที่รอดำเนินการ ดังนี้

  5. เลือกชื่อแอปที่ต้องการอนุมัติ
  6. ในหน้ารายละเอียดของแอป ให้เลือกปุ่มแก้ไขที่มุมบนขวา
  7. ในรายการผลิตภัณฑ์ API สำหรับแอป ในส่วนการดำเนินการ ให้ทำดังนี้
    • หากต้องการอนุมัติคีย์ ให้เลือกปุ่มอนุมัติสำหรับผลิตภัณฑ์ API แต่ละรายการที่ต้องมีการอนุมัติด้วยตนเอง

    • หากต้องการเพิกถอนคีย์ที่อนุมัติ ให้เลือกปุ่มเพิกถอนใต้การดำเนินการสำหรับผลิตภัณฑ์ API เพื่อเพิกถอนสิทธิ์เข้าถึง

  8. บันทึกแอป ตอนนี้คีย์ API ได้รับอนุมัติแล้ว

การควบคุมผลิตภัณฑ์ API และการแคชแอป

ระบบจะจัดเก็บข้อมูลเกี่ยวกับผลิตภัณฑ์ API และแอปของนักพัฒนาซอฟต์แวร์จากระยะไกลจากพอร์ทัลใน Apigee Edge ซึ่งหมายความว่าคุณจะเปลี่ยนแปลงผลิตภัณฑ์และแอป API ได้จาก Edge UI หรือ API โดยไม่ต้องผ่านพอร์ทัล เช่น เมื่อผู้ดูแลระบบแบ็กเอนด์เพิ่มผลิตภัณฑ์ API ใหม่ พอร์ทัลจะไม่ได้รับการอัปเดตด้วยข้อมูลดังกล่าวทันที

หากต้องการให้พอร์ทัลซิงค์กับแบ็กเอนด์ของ Edge อยู่เสมอ คุณอาจทริกเกอร์การอัปเดตแคชของพอร์ทัลด้วยตนเอง อัปเดตแคชโดยอัตโนมัติเมื่องาน Cron ของพอร์ทัลทำงาน หรือทั้ง 2 อย่างก็ได้ ตัวอย่างเช่น หากกำหนดค่างาน Cron ให้ทำงานบ่อยๆ เช่น ทุก 5 หรือ 10 นาที คุณอาจไม่ต้องการค่าใช้จ่ายในการอัปเดตผลิตภัณฑ์ API และแคชของแอปนักพัฒนาซอฟต์แวร์บ่อยครั้งขนาดนั้น ในกรณีนี้ คุณสามารถเริ่มการอัปเดตแคชด้วยตนเองได้ แต่หากงาน Cron ทำงานทุกชั่วโมงหรือ 2 ชั่วโมง เวลาที่ใช้ในการอัปเดตแคชอาจไม่มีผลมากนัก

โดยค่าเริ่มต้น พอร์ทัลจะได้รับการกำหนดค่าให้สร้างผลิตภัณฑ์ API และสร้างแคชของแอปนักพัฒนาซอฟต์แวร์อีกครั้ง ทุกครั้งที่ cron ทำงาน

หากต้องการระบุว่าจะสร้างแคชของผลิตภัณฑ์ API และแอปนักพัฒนาซอฟต์แวร์อีกครั้งทุกครั้งที่ Cron ทำงานหรือไม่

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. จากเมนู Drupal ให้เลือกการกำหนดค่า > การตั้งค่าพอร์ทัลนักพัฒนาซอฟต์แวร์ > การตั้งค่าแอปพลิเคชัน
  3. เลือกหรือยกเลิกการเลือกสร้างแคชของผลิตภัณฑ์ API และแอปนักพัฒนาซอฟต์แวร์อีกครั้งทุกครั้งที่ cron ทำงาน
  4. บันทึกการตั้งค่าของคุณ

วิธีอัปเดตแคชด้วยตนเอง

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. จากเมนู Drupal ให้เลือกไอคอนหน้าแรก > ล้างแคชทั้งหมด

การปรับแต่งช่องในแบบฟอร์มที่ใช้ในการลงทะเบียนแอป

เมื่อนักพัฒนาแอปลงทะเบียนแอป พอร์ทัลจะแสดงแบบฟอร์มเริ่มต้นดังนี้

ในฐานะผู้ให้บริการ API คุณอาจต้องแก้ไขแบบฟอร์มนี้เพื่อแจ้งให้นักพัฒนาแอประบุข้อมูลเพิ่มเติม เช่น รหัสลูกค้า แพลตฟอร์มเป้าหมายของแอป หรือข้อมูลอื่นๆ พอร์ทัลนี้ช่วยให้คุณสามารถเพิ่มฟิลด์ใหม่ลงในแบบฟอร์มนี้ เช่น ช่องต่อไปนี้

  • ต้องระบุหรือไม่บังคับ
  • แสดงโดยองค์ประกอบ HTML ต่างๆ เช่น กล่องข้อความ ปุ่มตัวเลือก ช่องทำเครื่องหมาย และอื่นๆ
  • สามารถตั้งค่าให้ปรากฏในที่ใดก็ได้ในแบบฟอร์มระหว่างช่อง URL เรียกกลับและช่องผลิตภัณฑ์

หากต้องการดูวิธีปรับแต่งแบบฟอร์มการลงทะเบียนแอปที่พร้อมให้ใช้งานจากพอร์ทัลนักพัฒนาซอฟต์แวร์ ให้ดูวิดีโอนี้

เช่น แบบฟอร์มต่อไปนี้แสดงช่องที่ต้องกรอกสําหรับรหัสลูกค้าและช่องที่ไม่บังคับสําหรับแพลตฟอร์มเป้าหมาย

เมื่อเพิ่มช่องใหม่ในแบบฟอร์ม ระบบจะอัปโหลดค่าของช่องไปยัง Edge พร้อมกับช่องอื่นๆ ทั้งหมดโดยอัตโนมัติเมื่อนักพัฒนาแอปส่งแบบฟอร์ม ซึ่งหมายความว่าคุณจะดูหรือแก้ไขช่องเหล่านั้นบน Edge หรือใช้ Edge Management API เพื่อเข้าถึงช่องเหล่านั้นจากสคริปต์ได้

เช่น ดูช่องของแบบฟอร์มใหม่ใน UI การจัดการ Edge โดยไปที่ "เผยแพร่ > แอปของนักพัฒนาซอฟต์แวร์" แล้วเลือกชื่อแอป ค่าของช่องใหม่จะปรากฏภายใต้ส่วนแอตทริบิวต์ที่กำหนดเองของหน้าเว็บโดยใช้ชื่อที่สอดคล้องกับชื่อภายในของช่อง ดังนี้

ค่าในช่องข้อมูลจะแสดงในส่วนรายละเอียดของแอปในหน้า "แอปของฉัน" ของนักพัฒนาแอปด้วย

นอกจากนี้ นักพัฒนาซอฟต์แวร์ยังแก้ไขค่าได้โดยเลือกลิงก์ "แก้ไข" สำหรับแอปในหน้า "แอปของฉัน"

ขั้นตอนต่อไปนี้อธิบายวิธีกำหนดค่าแบบฟอร์มการสร้างแอปโดยใช้อินเทอร์เฟซผู้ดูแลระบบ นักพัฒนาซอฟต์แวร์ Drupal จะปรับแต่งเพิ่มเติม รวมถึงแก้ไขหน้า "แอปของฉัน" ได้โดยใช้ฮุกที่กำหนดเอง หากต้องการเรียนรู้เพิ่มเติมเกี่ยวกับพฤติกรรมการเปลี่ยนแปลง ผ่านโค้ด ให้ดูตัวอย่าง API ของแอปในไฟล์: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php

วิธีเพิ่มช่องในแบบฟอร์มการลงทะเบียนแอป

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. ตรวจสอบว่าได้เปิดใช้โมดูลการจัดการแอตทริบิวต์แอป DevConnect แล้ว
  3. เลือกการกำหนดค่า > การตั้งค่าพอร์ทัลนักพัฒนาซอฟต์แวร์ > แอตทริบิวต์แอปพอร์ทัลนักพัฒนาซอฟต์แวร์ในเมนูการดูแลระบบ Drupal
  4. เลือกปุ่มเพิ่มแอตทริบิวต์แอปพอร์ทัลนักพัฒนาซอฟต์แวร์ที่ด้านบนของหน้า
  5. กำหนดค่าช่อง เช่น สำหรับช่องรหัสลูกค้าที่แสดงอยู่ด้านบน ให้ใช้การตั้งค่าต่อไปนี้
    • ชื่อภายใน = cust_id นี่คือชื่อของตัวแปรที่ใช้จัดเก็บค่าของช่อง
    • Public Name = รหัสลูกค้า
    • คำอธิบาย = ป้อนรหัสลูกค้า
    • เลือกช่องทำเครื่องหมาย "ต้องใช้แอตทริบิวต์นี้"
    • เลือกช่องทำเครื่องหมายสำหรับ แสดงแอตทริบิวต์นี้
    • วิดเจ็ต = กล่องข้อความ
    • เลือก "บันทึก" เพื่อกลับไปที่หน้าแอตทริบิวต์แอปพอร์ทัลนักพัฒนาซอฟต์แวร์
  6. เลือกบันทึกการเปลี่ยนแปลง
  7. เลือกไอคอนหน้าแรก > ล้างแคชทั้งหมดจากเมนู Drupal
    คุณอาจต้องล้างแคชของเบราว์เซอร์ก่อนที่ช่องใหม่จะปรากฏในแบบฟอร์ม

หากต้องการเพิ่มช่องที่ไม่บังคับให้นักพัฒนาแอประบุแพลตฟอร์มสำหรับแอป ให้ตั้งค่าแอตทริบิวต์ของช่องดังต่อไปนี้

  • ชื่อภายใน = intent_platforms
  • ชื่อสาธารณะ = แพลตฟอร์ม
  • คำอธิบาย = ระบุแพลตฟอร์มอย่างน้อย 1 รายการสำหรับแอป
  • ล้างช่องทำเครื่องหมาย "ต้องมีแอตทริบิวต์นี้"
  • เลือกช่องทำเครื่องหมายสำหรับ "แสดงแอตทริบิวต์นี้"
  • วิดเจ็ต = รายการช่องทำเครื่องหมาย
  • เลือก "บันทึก" เพื่อกลับไปที่หน้าแอตทริบิวต์แอปพอร์ทัลนักพัฒนาซอฟต์แวร์

หากต้องการเรียงลำดับแอตทริบิวต์ในแบบฟอร์มใหม่ ให้ทำดังนี้

  1. เข้าสู่ระบบพอร์ทัลในฐานะผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบหรือสิทธิ์ในการสร้างเนื้อหา
  2. เลือกการกำหนดค่า > การตั้งค่าพอร์ทัลนักพัฒนาซอฟต์แวร์ > แอตทริบิวต์แอปพอร์ทัลนักพัฒนาซอฟต์แวร์ในเมนูการดูแลระบบ Drupal
  3. เลือกเครื่องหมายบวก + ใต้คอลัมน์ชื่อแล้วลากพร็อพเพอร์ตี้ไปยังตำแหน่งที่ต้องการแสดงในแบบฟอร์ม
  4. บันทึกการเปลี่ยนแปลง