Pielāgotas API izveide Power Apps

Veidojot pielāgotu API, ir jāizmanto risinājums. Ja neesat iepazinies ar risinājumiem, vispirms izlasiet rakstu Risinājuma izveide.

Jūsu risinājumam ir jābūt saistītam ar izdevēju. Izdevējam ir saistīts īpašs pielāgošanas prefikss. Veidojot pielāgotu API, ir jāizmanto pielāgošanas prefikss, un šim prefiksam ir jābūt tādam pašam, kādu izmanto jūsu risinājuma izdevējs. Tālāk sniegtajos norādījumos vērtība sample tiek izmantota kā pielāgošanas prefikss, jo tā ir iestatīta izdevējam.

Svarīgi

  • Tagad ir labāka pieredze pielāgotu API izveidei. Spraudņa reģistrācijas rīkā varat izmantot noformētāju. Papildinformācija Pielāgotas API izveide, izmantojot spraudņu reģistrācijas rīku
  • Daudzus laukus, kas saistīti ar pielāgotas API izveidi, pēc to izveides nevar mainīt. Pirms sākat darbu, rūpīgi jāplāno pielāgotās API dizains. Ja vēlāk nolemjat, ka pēc pielāgotā API izveides ir jāmaina lietas, iespējams, būs jāizdzēš esošais ieraksts un atkārtoti jāizveido pielāgotais API. Pārskatiet informāciju par kolonnām, kuras nevar mainīt šeit: Pielāgotas API tabulas

Pielāgota API ieraksta izveide

  1. Risinājumā nolaižamajā izvēlnē atlasiet Jauns>cits>>pielāgots API.

  2. Rediģējiet laukus, lai iestatītu pielāgotās API rekvizītus. Vērtības ir jāiestata tālāk norādītajiem laukiem. Papildinformāciju skatiet sadaļā Pielāgotas API tabulas kolonnas

    Pirms spraudņa izveides nevar iestatīt spraudņa tipa vērtības. Šo iestatījumu vēlāk varat mainīt.

  3. Atlasiet vienumu Saglabāt. Jūsu veidlapai vajadzētu izskatīties apmēram šādi: Saglabāta pielāgota API veidlapa.

Pieprasījuma parametru izveide

Pielāgotai API nav nepieciešami parametri. Izveidojiet tik daudz parametru, cik nepieciešams, lai nodotu loģikai nepieciešamos datus.

  1. Risinājumā nolaižamajā izvēlnē atlasiet Jauns>cits>>pielāgots API pieprasījuma parametrs.

  2. Rediģējiet laukus, lai iestatītu pielāgotā API pieprasījuma parametra rekvizītus. Papildinformāciju skatiet sadaļā CustomAPIRequestParameter tabulas kolonnas

  3. Atlasiet vienumu Saglabāt. Jūsu veidlapai vajadzētu izskatīties apmēram šādi:

    Pielāgotas API pieprasījuma parametru veidlapas piemērs.

Atbildes rekvizītu izveide

Pielāgotai API, kas attēlo darbību, nav nepieciešami atbildes rekvizīti. Funkcijai jābūt vismaz vienai. Ja operācija ir veiksmīga, tā atgriež veiksmīgu atbildi. Ja tas neizdodas, tas atgriež kļūdu. Jums ir jādefinē atbildes rekvizīti visiem datiem, ko atgriež jūsu API.

Ja ir definēts tikai viens atbildes rekvizīts Entity vai EntityCollection , atbilde ir šāda tipa. Ja ir vairāki rekvizīti vai viens vai vairāki vienkārša tipa rekvizīti, API atgriež kompleksu tipu, kur katrs atbildes rekvizīts ir šī kompleksā tipa rekvizīts.

Piemēram, ja pielāgotais API unikālais nosaukums ir sample_CustomAPIExample, tas atgriež sarežģītu tipu sample_CustomAPIExampleResponse ar rekvizītiem katram definētajam atbildes rekvizītam.

  1. Risinājumā nolaižamajā izvēlnē atlasiet Jauns>cits>>pielāgots API atbildes rekvizīts.

  2. Rediģējiet laukus, lai iestatītu pielāgotā API atbildes rekvizīta rekvizītus. Papildinformāciju skatiet sadaļā CustomAPIResponseProperty tabulas kolonnas

  3. Atlasiet vienumu Saglabāt. Jūsu veidlapai vajadzētu izskatīties apmēram šādi:

    Pielāgota API atbildes rekvizīta veidlapa.

Ievērojiet rezultātu pakalpojuma dokumentā

Ja neesat iestatījis pielāgotās IsPrivate API rekvizītu, tagad varat izgūt pakalpojuma definīciju no CSDL $metadata dokumentaGET, izmantojot pieprasījumu, pat no pārlūkprogrammas. Ja jūsu vides URL ir https://yourorg.crm.dynamics.com, varat ierakstīt šo URL pārlūkprogrammas adreses laukā, lai izgūtu $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Meklējiet rezultātu, lai atrastu pielāgotās API nosaukumu. Piemēram, API, kas definēta, izmantojot iepriekš minētās darbības, izskatās šādi:

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

Pielāgotās API testēšana

Kad esat izveidojis pielāgotu API, varat to izmēģināt. Pat ja neesat iestatījis spraudņa tipu, lai definētu galveno operāciju, varat to pārbaudīt tūlīt, lai pārbaudītu, vai varat to pareizi izsaukt. Jebkurš atbildes rekvizīts atgriež noklusējuma vērtību, piemēram, null. Papildinformācija Pielāgotu API izsaukšana.

Pielāgotā API spraudņa tipa atjaunināšana

Informāciju par to, kā rakstīt spraudni pielāgotai API, skatiet sadaļā Spraudņa rakstīšana pielāgotai API.

Pēc montāžas reģistrēšanas jums ir jāiestata spraudņa tipa vērtība izveidotajam pielāgotajam API. Šis ir uzmeklēšanas rekvizīts, tāpēc jums vienkārši jāatrod spraudņa tips, kas apzīmē tipu, kas izveidots, reģistrējot montāžu.

Iestatiet pielāgoto API spraudņa tipa uzmeklēšanu.

Kad esat iestatījis spraudņa veidu, varat pārbaudīt pielāgoto API, lai pārbaudītu, vai tiek atgriezti pareizie rezultāti.

Citi veidi, kā izveidot pielāgotas API

Spraudņu reģistrācijas rīks nodrošina pielāgotu API noformētāju. Papildinformācija Pielāgotas API izveide, izmantojot spraudņu reģistrācijas rīku

Iespējams, jums ir prasības izveidot klienta lietojumprogrammu, kas ļauj izveidot pielāgotus API ārpus noformētāja. Tā kā pielāgoto API dati tiek glabāti tabulās, tos var izveidot, izmantojot kodu. Papildinformācija Pielāgotas API izveide ar kodu.

Jūsu ALM procesu var labāk nodrošināt, izveidojot pielāgotus API, rediģējot risinājumu failus. Papildinformācija Pielāgotas API izveide ar risinājuma failiem.

Skatiet arī:

Pielāgotu API izveide un izmantošana
Pielāgotas API izveide, izmantojot spraudņa reģistrācijas rīku
Pielāgotas API izveide ar kodu
Pielāgotas API izveide ar risinājuma failiem
Savu ziņojumu izveide

  • Last updated on