Crearea unui API personalizat în Power Apps

Când creați un API personalizat, trebuie să utilizați o soluție. Dacă nu sunteți familiarizat cu soluțiile, citiți mai întâi Crearea unei soluții.

Soluția trebuie să fie asociată cu un editor. Editorul are un prefix de particularizare specific asociat cu acesta. Trebuie să utilizați un prefix de particularizare atunci când creați un API particularizat, iar acest prefix trebuie să fie același utilizat de editorul soluției. Următoarele instrucțiuni utilizează valoarea sample ca prefix de particularizare, deoarece este cel setat pentru editor.

Important

• Acum există o experiență mai bună pentru crearea unui API personalizat. Puteți utiliza un proiectant în instrumentul de înregistrare Plug-in. Informații suplimentare: Crearea unui API personalizat utilizând instrumentul de înregistrare a plug-in-ului
• Multe câmpuri legate de crearea unui API personalizat nu pot fi modificate după ce le creați. Ar trebui să planificați cu atenție designul API-ului personalizat înainte de a începe. Dacă mai târziu decideți că trebuie să modificați lucrurile după ce creați API-ul personalizat, poate fi necesar să ștergeți înregistrarea existentă și să recreați API-ul personalizat. Examinați informațiile despre coloanele care nu pot fi modificate aici: Tabele CustomAPI

Creați o înregistrare API personalizată

1. În soluția dvs., selectați Mai>multe>alte API>particularizate din meniul vertical.

2. Editați câmpurile pentru a seta proprietățile API-ului personalizat. Trebuie să setați valori pentru următoarele câmpuri. Pentru mai multe informații, consultați Coloanele de tabel API personalizate

   Nu puteți seta valori pentru Tip de plug-in înainte de a crea plug-in-ul. Îl puteți modifica mai târziu.

3. Selectați Salvați. Formularul tău ar trebui să arate cam așa:

Creați orice parametri de solicitare

Un API personalizat nu necesită parametri. Creați câți parametri aveți nevoie pentru a transmite datele necesare pentru logica dvs.

1. În soluția dvs., selectați Nou>Mai multe>alte>parametre de solicitare API personalizate din meniul vertical.

2. Editați câmpurile pentru a seta proprietățile parametrului de solicitare API personalizat. Pentru mai multe informații, consultați Coloanele tabelului CustomAPIRequestParameter

3. Selectați Salvați. Formularul tău ar trebui să arate cam așa:

   

Creați orice proprietăți de răspuns

Un API personalizat care reprezintă o acțiune nu necesită proprietăți de răspuns. O funcție trebuie să aibă cel puțin unul. Dacă operațiunea reușește, returnează un răspuns de succes. Dacă eșuează, returnează o eroare. Ar trebui să definiți proprietăți de răspuns pentru toate datele pe care le returnează API-ul dvs.

Dacă există o singură proprietate de răspuns Entity sau EntityCollection definită, răspunsul este de acel tip. Dacă există mai multe proprietăți sau una sau mai multe proprietăți de tip simplu, API-ul returnează un tip complex în care fiecare proprietate de răspuns este o proprietate de acel tip complex.

De exemplu, dacă numele unic API personalizat este sample_CustomAPIExample, returnează un tip complex numit sample_CustomAPIExampleResponse cu proprietăți pentru fiecare proprietate de răspuns pe care o definiți.

1. În soluția dvs., selectați Nou>Mai multe>alte proprietăți>de răspuns API personalizate din meniul vertical.

2. Editați câmpurile pentru a seta proprietățile proprietății personalizate API Response. Pentru mai multe informații, consultați CustomAPIResponseProperty Coloanele tabelului

3. Selectați Salvați. Formularul tău ar trebui să arate cam așa:

   

Observați rezultatul în documentul de service

Dacă nu ați setat proprietatea pentru API-ul IsPrivate personalizat, acum puteți prelua definiția serviciului din documentul CSDL $metadata folosind o GET solicitare, chiar și din browser. Dacă adresa URL pentru mediul dvs. este https://yourorg.crm.dynamics.com, puteți introduce această adresă URL în câmpul adresei browserului pentru a prelua $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Căutați rezultatul pentru a găsi numele API-ului personalizat. De exemplu, API-ul definit folosind pașii de mai sus arată astfel:

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

Testează-ți API-ul personalizat

După ce creați API-ul personalizat, îl puteți încerca. Chiar dacă nu ați setat un tip de plug-in pentru a defini operațiunea principală, îl puteți testa acum pentru a verifica dacă îl puteți apela corect. Orice proprietăți de răspuns returnează valoarea implicită, cum ar fi null. Informații suplimentare: Invocarea API-urilor particularizate.

Actualizați tipul de plugin API personalizat

Pentru informații despre cum să scrieți un plug-in pentru un API particularizat, consultați Scrierea unui plug-in pentru API-ul personalizat.

După ce vă înregistrați ansamblul, trebuie să setați valoarea Tip de plugin pentru API-ul personalizat pe care l-ați creat. Aceasta este o proprietate de căutare, deci trebuie doar să găsiți tipul de inserție care reprezintă tipul creat atunci când ați înregistrat ansamblul.

După ce ați setat tipul de plugin, puteți testa API-ul personalizat pentru a verifica dacă rezultatele corecte sunt returnate.

Alte modalități de a crea API-uri personalizate

Instrumentul de înregistrare a pluginului oferă un designer API personalizat. Informații suplimentare: Crearea unui API personalizat utilizând instrumentul de înregistrare a plug-in-ului

Este posibil să aveți cerințe pentru a crea o aplicație client care să permită crearea de API-uri personalizate în afara proiectantului. Deoarece datele pentru API-urile personalizate sunt stocate în tabele, le puteți crea folosind cod. Informații suplimentare: Creați un API personalizat cu cod.

Procesul ALM ar putea fi mai bine deservit prin crearea de API-uri personalizate prin editarea fișierelor de soluție. Informații suplimentare: Creați un API particularizat cu fișiere de soluție.

Consultați și

Creați și utilizați API-uri personalizate
Creați un API personalizat folosind instrumentul de înregistrare a plug-in-ului
Creați un API personalizat cu cod
Creați un API personalizat cu fișiere de soluție
Creați-vă propriile mesaje