Cipta API tersuai dalam Power Apps

Artikel ini menerangkan cara mencipta API tersuai dalam Power Apps untuk Microsoft Dataverse dengan menggunakan penyelesaian. Ikuti langkah-langkah ini untuk mentakrifkan sifat permintaan dan respons, menguji API tersuai, dan mengaitkan jenis plug-innya. Jika anda tidak biasa dengan penyelesaian, baca dahulu Cipta penyelesaian.

Penyelesaian anda mesti dikaitkan dengan penerbit. Penerbit mempunyai awalan penyesuaian khusus yang dikaitkan dengannya. Anda mesti menggunakan awalan penyesuaian semasa mencipta API tersuai, dan awalan ini harus sama seperti yang digunakan oleh penerbit penyelesaian anda. Arahan berikut menggunakan nilai sample sebagai awalan penyesuaian kerana ia adalah yang ditetapkan untuk penerbit.

Penting

• Kini terdapat pengalaman yang lebih baik untuk mencipta API tersuai. Anda boleh menggunakan pereka bentuk dalam alat pendaftaran Pemalam. Untuk maklumat lanjut, lihat Cipta API tersuai menggunakan alat pendaftaran plug-in.
• Anda tidak boleh mengubah banyak medan berkaitan penciptaan API tersuai selepas anda menciptanya. Rancang reka bentuk API tersuai dengan teliti sebelum anda mula. Jika anda kemudian memutuskan bahawa anda perlu menukar medan ini, anda mungkin perlu memadam rekod sedia ada dan mencipta semula API tersuai. Untuk maklumat lanjut, lihat jadual CustomAPI.

Cipta rekod API tersuai

1. Dalam penyelesaian anda, pilihAPI tersuai>Lebih Baharu>> daripada juntai lungsur.

2. Edit medan untuk menetapkan sifat API tersuai anda. Tetapkan nilai untuk medan berikut. Untuk maklumat lanjut, lihat Lajur jadual API tersuai.

   Anda tidak boleh mengesetkan nilai untuk Jenis Pemalam sebelum anda mencipta pemalam. Anda boleh menukar nilai ini kemudian.

3. Pilih Simpan. Borang anda harus kelihatan serupa dengan imej berikut:

Cipta parameter permintaan

API tersuai tidak memerlukan parameter. Cipta seberapa banyak parameter yang anda perlukan untuk menghantar data yang diperlukan untuk logik anda.

1. Dalam penyelesaiananda, pilih>Lain>Baharu> daripada menu lungsur.

2. Edit medan untuk menetapkan sifat parameter permintaan API tersuai anda. Untuk maklumat lanjut, lihat Lajur Jadual CustomAPIRequestParameters.

3. Pilih Simpan. Borang anda sepatutnya kelihatan serupa dengan imej berikut:

   

Cipta sifat respons

API tersuai yang mewakili Tindakan tidak memerlukan sifat respons. Fungsi mesti mempunyai sekurang-kurangnya satu. Jika operasi berjaya, ia mengembalikan respons kejayaan. Jika gagal, ia mengembalikan ralat. Tentukan sifat respons untuk sebarang data yang dikembalikan oleh API anda.

Jika anda hanya mentakrifkan satu sifat respons Entity atau EntityCollection , respons tersebut adalah jenis tersebut. Jika anda mentakrifkan beberapa sifat, atau satu atau lebih sifat jenis mudah, API akan mengembalikan jenis kompleks di mana setiap sifat respons adalah sifat bagi jenis kompleks tersebut.

Sebagai contoh, jika nama unik API tersuai anda ialah sample_CustomAPIExample, ia mengembalikan jenis kompleks yang dinamakan sample_CustomAPIExampleResponse dengan sifat untuk setiap sifat respons yang anda tentukan.

1. Dalam penyelesaian anda, pilihSifat Respons API Tersuai>>> daripada juntai bawah.

2. Edit medan untuk menetapkan sifat respons API tersuai anda. Untuk maklumat lanjut, lihat Lajur Jadual CustomAPIResponseProperty.

3. Pilih Simpan. Borang anda sepatutnya kelihatan serupa dengan imej berikut:

   

Perhatikan keputusan dalam dokumen perkhidmatan

Jika anda tidak menetapkan IsPrivate sifat untuk API tersuai anda, anda boleh mendapatkan definisi perkhidmatan dari dokumen CSDL $metadata dengan menggunakan GET permintaan, malah dari pelayar anda. Jika URL untuk persekitaran anda ialah https://yourorg.crm.dynamics.com, anda boleh taip URL ini dalam medan alamat pelayar anda untuk mendapatkan $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Cari hasil untuk mencari nama API tersuai. Sebagai contoh, API yang ditakrifkan menggunakan langkah-langkah sebelumnya kelihatan seperti berikut:

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

Uji API tersuai anda

Selepas anda mencipta API tersuai anda, anda boleh mencubanya. Walaupun anda tidak menetapkan jenis plug-in untuk mentakrifkan operasi utama, anda boleh mengujinya sekarang untuk mengesahkan bahawa anda boleh memanggilnya dengan betul. Sebarang sifat respons mengembalikan nilai lalainya, seperti null. Untuk maklumat lanjut, lihat Memanggil API tersuai.

Kemas kini jenis pemalam API tersuai

Untuk mendapatkan maklumat tentang cara menulis pemalam untuk api tersuai, lihat Menulis Pemalam untuk API tersuai anda.

Selepas anda mendaftarkan pemasangan anda, anda perlu menetapkan nilai Jenis Pemalam untuk API tersuai yang anda buat. Nilai ini adalah sifat carian, jadi anda hanya perlu mencari Jenis Plug-in yang mewakili jenis yang dicipta semasa anda mendaftar pemasangan.

Selepas anda menetapkan Jenis Plugin, anda boleh menguji API tersuai anda untuk mengesahkan keputusan yang betul dikembalikan.

Cara lain untuk mencipta API tersuai

Alat pendaftaran pemalam menyediakan pereka API tersuai. Untuk maklumat lanjut, lihat Cipta API tersuai menggunakan alat pendaftaran plug-in.

Anda mungkin mempunyai keperluan untuk mencipta aplikasi klien yang membenarkan penciptaan API tersuai di luar pereka bentuk. Oleh kerana data untuk API tersuai disimpan dalam jadual, anda boleh menciptanya menggunakan kod. Untuk maklumat lanjut, lihat Cipta API tersuai dengan kod.

Proses ALM anda mungkin lebih baik dilayan dengan mencipta API tersuai dengan mengedit fail penyelesaian. Untuk maklumat lanjut, lihat Cipta API tersuai dengan fail penyelesaian.

Lihat juga

Cipta dan gunakan API tersuai
Cipta API tersuai menggunakan alat pendaftaran pemalam
Cipta API tersuai dengan kod
Cipta API tersuai dengan fail penyelesaian
Cipta mesej anda sendiri