Cipta API tersuai dalam Power Apps

Apabila mencipta API tersuai, anda mesti menggunakan penyelesaian. Jika anda tidak biasa dengan penyelesaian, mula-mula baca 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 hendaklah sama 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. Maklumat lanjut: Cipta API tersuai menggunakan alat pendaftaran pemalam
• Banyak medan yang berkaitan dengan mencipta API tersuai tidak boleh diubah selepas anda menciptanya. Anda harus merancang reka bentuk API tersuai dengan teliti sebelum anda memulakan. Jika anda kemudian memutuskan bahawa anda perlu mengubah sesuatu selepas anda mencipta API tersuai, anda mungkin perlu memadamkan rekod sedia ada dan mencipta semula API tersuai. Semak maklumat tentang lajur yang tidak boleh diubah di sini: Jadual CustomAPI

Cipta rekod API tersuai

1. Dalam penyelesaian anda, pilihAPI tersuaiLebih Baharu>>Lain> daripada juntai lungsur.

2. Edit medan untuk menetapkan sifat API tersuai anda. Anda mesti mengesetkan 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 mengubah ini kemudian.

3. Pilih Simpan. Borang anda sepatutnya kelihatan seperti ini:

Buat sebarang 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, pilihParameter Permintaan API TersuaiLain>Baharu>> daripada menu lungsur.

2. Edit medan untuk mengesetkan sifat Parameter Permintaan API tersuai anda. Untuk maklumat lanjut, lihat Lajur Jadual CustomAPIRequestParameter

3. Pilih Simpan. Borang anda sepatutnya kelihatan seperti ini:

   

Cipta sebarang 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. Anda harus mentakrifkan sifat respons untuk sebarang data yang dikembalikan oleh API anda.

Jika terdapat hanya satu sifat respons Entiti atau EntityCollection yang ditakrifkan, respons adalah daripada jenis tersebut. Jika terdapat berbilang sifat, atau satu atau lebih sifat jenis mudah, API mengembalikan jenis kompleks di mana setiap sifat respons ialah sifat jenis kompleks tersebut.

Contohnya, 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 TersuaiLain>Baharu>> daripada juntai bawah.

2. Edit medan untuk mengesetkan sifat Sifat Respons API tersuai anda. Untuk maklumat lanjut, lihat Lajur Jadual CustomAPIResponseProperty

3. Pilih Simpan. Borang anda sepatutnya kelihatan seperti ini:

   

Perhatikan keputusan dalam dokumen perkhidmatan

Jika anda belum mengesetkan IsPrivate sifat untuk API tersuai anda, anda kini boleh mendapatkan semula takrifan perkhidmatan daripada dokumen $metadata CSDL menggunakan GET permintaan, walaupun daripada penyemak imbas anda. Jika url untuk persekitaran anda ialah https://yourorg.crm.dynamics.com, anda boleh menaip URL ini dalam medan alamat penyemak imbas anda untuk mendapatkan semula $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 di atas kelihatan seperti ini:

<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 belum menetapkan jenis pemalam untuk menentukan operasi utama, anda boleh mengujinya sekarang untuk mengesahkan bahawa anda boleh memanggilnya dengan betul. Sebarang sifat respons mengembalikan nilai lalainya, seperti null. Maklumat lanjut: 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. Ini ialah sifat carian, jadi anda hanya perlu mencari Jenis Pemalam yang mewakili jenis yang dibuat semasa anda mendaftarkan perhimpunan.

Sebaik sahaja anda menetapkan Jenis Pemalam, anda boleh menguji API tersuai anda untuk mengesahkan hasil yang betul dikembalikan.

Cara lain untuk mencipta API tersuai

Alat pendaftaran pemalam menyediakan pereka API tersuai. Maklumat lanjut: Cipta API tersuai menggunakan alat pendaftaran pemalam

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. Maklumat lanjut: Cipta API tersuai dengan kod.

Proses ALM anda mungkin lebih baik dilayan dengan mencipta API tersuai dengan mengedit fail penyelesaian. Maklumat lanjut: 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