สร้าง API แบบกําหนดเองใน Power Apps

บทความนี้อธิบายวิธีการสร้าง API แบบกําหนดเองใน Power Apps สําหรับ Microsoft Dataverse โดยใช้โซลูชัน ทําตามขั้นตอนเหล่านี้เพื่อกําหนดคําขอและคุณสมบัติการตอบกลับ ทดสอบ API แบบกําหนดเอง และเชื่อมโยงประเภทปลั๊กอิน หากคุณไม่คุ้นเคยกับโซลูชัน ก่อนอื่นให้อ่าน สร้างโซลูชัน

โซลูชันของคุณต้องเชื่อมโยงกับผู้เผยแพร่ ผู้เผยแพร่มีคํานํหน้าการปรับแต่งเฉพาะที่เกี่ยวข้องกับมัน คุณต้องใช้คํานําหน้าการกําหนดค่าเมื่อสร้าง API แบบกําหนดเอง และคํานําหน้านี้ควรเป็นคํานําหน้าเดียวกับที่ใช้โดยผู้เผยแพร่โซลูชันของคุณ คําแนะนําต่อไปนี้ใช้ค่า sample เป็นคํานําหน้าการกําหนดค่าเนื่องจากเป็นชุดหนึ่งสําหรับผู้เผยแพร่

สําคัญ

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

สร้างระเบียน API แบบกําหนดเอง

1. ในโซลูชันของคุณ เลือกใหม่>เพิ่มเติม>API แบบกําหนดเอง> จากรายการแบบดรอปดาวน์

2. แก้ไขเขตข้อมูลเพื่อตั้งค่าคุณสมบัติของ API แบบกําหนดเองของคุณ ตั้งค่าสําหรับเขตข้อมูลต่อไปนี้ สําหรับข้อมูลเพิ่มเติม ดูคอลัมน์ตาราง API แบบกําหนดเอง

   คุณไม่สามารถตั้งค่าสําหรับ ชนิดปลั๊กอิน ก่อนที่คุณจะสร้างปลั๊กอิน คุณสามารถเปลี่ยนค่านี้ได้ในภายหลัง

3. เลือก บันทึก ฟอร์มของคุณควรมีลักษณะคล้ายกับรูปภาพต่อไปนี้:

สร้างพารามิเตอร์คําขอ

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

1. ในโซลูชันของคุณ เลือกใหม่>เพิ่มเติม>พารามิเตอร์คําขอ API แบบกําหนดเอง> จากรายการแบบเลื่อนลง

2. แก้ไขเขตข้อมูลเพื่อตั้งค่าคุณสมบัติของพารามิเตอร์คําขอ API แบบกําหนดเองของคุณ สําหรับข้อมูลเพิ่มเติม ดูคอลัมน์ของตาราง CustomAPIRequestParameter

3. เลือก บันทึก ฟอร์มของคุณควรมีลักษณะคล้ายกับรูปภาพต่อไปนี้:

   

สร้างคุณสมบัติการตอบสนอง

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

ถ้าคุณกําหนดเพียง เอนทิตี เดียวหรือคุณสมบัติการตอบสนอง EntityCollection การตอบสนองจะเป็นชนิดนั้น ถ้าคุณกําหนดคุณสมบัติหลายรายการ หรือคุณสมบัติอย่างน้อยหนึ่งของประเภทง่ายๆ API จะส่งกลับชนิดที่ซับซ้อนโดยที่แต่ละคุณสมบัติการตอบสนองเป็นคุณสมบัติของประเภทที่ซับซ้อนนั้น

ตัวอย่างเช่น ถ้าชื่อ API แบบกําหนดเองของคุณคือ sample_CustomAPIExampleจะส่งกลับชนิดที่ซับซ้อนที่ sample_CustomAPIExampleResponse ชื่อว่า ด้วยคุณสมบัติสําหรับแต่ละคุณสมบัติการตอบสนองที่คุณกําหนด

1. ในโซลูชันของคุณ เลือกใหม่>เพิ่มเติม>คุณสมบัติการตอบสนอง API แบบกําหนดเอง> จากรายการแบบดรอปดาวน์

2. แก้ไขเขตข้อมูลเพื่อตั้งค่าคุณสมบัติของคุณสมบัติการตอบสนอง API แบบกําหนดเองของคุณ สําหรับข้อมูลเพิ่มเติม โปรดดูคอลัมน์ CustomAPIResponseProperty Table

3. เลือก บันทึก ฟอร์มของคุณควรมีลักษณะคล้ายกับรูปภาพต่อไปนี้:

   

สังเกตผลลัพธ์ในเอกสารบริการ

ถ้าคุณไม่ได้ตั้งค่า IsPrivate คุณสมบัติสําหรับ API แบบกําหนดเองของคุณ คุณสามารถเรียกใช้ข้อกําหนดบริการจาก เอกสาร$metadata CSDL โดยใช้ GET คําขอ แม้แต่จากเบราว์เซอร์ของคุณ ถ้า URL สําหรับสภาพแวดล้อมของคุณคือ https://yourorg.crm.dynamics.comคุณสามารถพิมพ์ URL นี้ในเขตข้อมูลที่อยู่เบราว์เซอร์ของคุณเพื่อดึงข้อมูล$metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata

ค้นหาผลลัพธ์เพื่อค้นหาชื่อของ API แบบกําหนดเอง ตัวอย่างเช่น API ที่กําหนดโดยใช้ขั้นตอนก่อนหน้านี้จะมีลักษณะดังนี้:

<ComplexType Name="sample_CustomAPIExampleResponse">
    <Property Name="StringProperty" Type="Edm.String" Unicode="false" />
</ComplexType>
<Action Name="sample_CustomAPIExample">
    <Parameter Name="StringParameter" Type="Edm.String" Nullable="false" Unicode="false" />
    <ReturnType Type="mscrm.sample_CustomAPIExampleResponse" Nullable="false" />
</Action>

ทดสอบ API แบบกําหนดเองของคุณ

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

อัปเดตชนิดปลั๊กอิน API แบบกําหนดเอง

สําหรับข้อมูลเกี่ยวกับวิธีการเขียนปลั๊กอินสําหรับ API แบบกําหนดเอง ดูเขียนปลั๊กอินสําหรับ API แบบกําหนดเองของคุณ

หลังจากที่คุณลงทะเบียนแอสเซมบลีของคุณแล้ว คุณจําเป็นต้องตั้งค่า ประเภทปลั๊กอิน สําหรับ API แบบกําหนดเองที่คุณสร้างขึ้น ค่านี้เป็นคุณสมบัติการค้นหา ดังนั้นคุณเพียงแค่ต้องค้นหาชนิดปลั๊กอินที่แสดงชนิดที่สร้างขึ้นเมื่อคุณลงทะเบียนแอสเซมบลี

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

วิธีอื่น ๆ ในการสร้าง API แบบกําหนดเอง

เครื่องมือลงทะเบียนปลั๊กอินมีตัวออกแบบ API แบบกําหนดเอง สําหรับข้อมูลเพิ่มเติม ดูสร้าง API แบบกําหนดเองโดยใช้เครื่องมือลงทะเบียนปลั๊กอิน

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

กระบวนการ ALM ของคุณอาจจะทํางานได้ดียิ่งขึ้นด้วยการสร้าง API แบบกําหนดเองโดยการแก้ไขไฟล์โซลูชัน สําหรับข้อมูลเพิ่มเติม ดูสร้าง API แบบกําหนดเองด้วยไฟล์โซลูชัน

ดูเพิ่มเติม

สร้างและใช้ API แบบกําหนดเอง
สร้าง API แบบกําหนดเองโดยใช้เครื่องมือลงทะเบียนปลั๊กอิน
สร้าง API แบบกําหนดเองด้วยรหัส
สร้าง API แบบกําหนดเองด้วยไฟล์โซลูชัน
สร้างข้อความของคุณเอง