Opprette en egendefinert API i Power Apps

Når du oppretter en egendefinert API, må du bruke en løsning. Hvis du ikke er kjent med løsninger, må du først lese Opprett en løsning.

Løsningen må være knyttet til en utgiver. Utgiveren har et bestemt tilpassingsprefiks knyttet til det. Du må bruke et tilpassingsprefiks når du oppretter en egendefinert API, og dette prefikset skal være det samme som brukes av utgiveren av løsningen. Følgende instruksjoner bruker verdien sample som tilpassingsprefiks fordi det er det ene settet for utgiveren.

Viktig!

• Det finnes nå en bedre opplevelse for å opprette egendefinert API. Du kan bruke en utformer i registreringsverktøyet for programtillegg. Mer informasjon: Opprette en egendefinert API ved hjelp av registreringsverktøyet for programtillegg
• Mange felt relatert til oppretting av egendefinert API kan ikke endres etter at du har opprettet dem. Du bør planlegge utformingen av den egendefinerte API-en nøye før du begynner. Hvis du senere bestemmer deg for at du må endre ting etter at du har opprettet den egendefinerte API-en, må du kanskje slette den eksisterende posten og opprette den egendefinerte API-en på nytt. Se gjennom informasjonen om kolonnene som ikke kan endres her: CustomAPI-tabeller

Opprette en egendefinert API-post

1. Velg ny>egendefinert>>API fra rullegardinlisten i løsningen.

2. Rediger feltene for å angi egenskapene for den egendefinerte API-en. Du må angi verdier for følgende felt. Hvis du vil ha mer informasjon, kan du se Egendefinerte API-tabellkolonner

   Du kan ikke angi verdier for plugin-modultype før du oppretter plugin-modulen. Du kan endre dette senere.

3. Velg Lagre. Skjemaet skal se omtrent slik ut:

Opprett alle forespørselsparametere

En egendefinert API krever ikke parametere. Opprett så mange parametere som du trenger for å sende data som er nødvendige for logikken.

1. Velg Ny>mer>>egendefinert API-forespørselsparameter fra rullegardinlisten i løsningen.

2. Rediger feltene for å angi egenskapene for den egendefinerte API-forespørselsparameteren. Hvis du vil ha mer informasjon, kan du se Tabellkolonner for CustomAPIRequestParameter

3. Velg Lagre. Skjemaet skal se omtrent slik ut:

   

Opprett eventuelle svaregenskaper

En egendefinert API som representerer en handling, krever ikke svaregenskaper. En funksjon må ha minst én. Hvis operasjonen lykkes, returnerer den et vellykket svar. Hvis den mislykkes, returneres en feil. Du bør definere svaregenskaper for alle data som API-en returnerer.

Hvis det bare er definert en enkelt enhets- eller EntityCollection-svaregenskap , er svaret av denne typen. Hvis det finnes flere egenskaper eller én eller flere egenskaper av en enkel type, returnerer API-en en kompleks type der hver svaregenskap er en egenskap av denne komplekse typen.

Hvis for eksempel det egendefinerte API-unike navnet er sample_CustomAPIExample, returnerer det en kompleks type med sample_CustomAPIExampleResponse egenskaper for hver svaregenskap du definerer.

1. Velg Ny>mer>>egendefinert API-svaregenskap fra rullegardinlisten i løsningen.

2. Rediger feltene for å angi egenskapene for den egendefinerte API-svaregenskapen. Hvis du vil ha mer informasjon, kan du se CustomAPIResponseProperty-tabellkolonner

3. Velg Lagre. Skjemaet bør se omtrent slik ut:

   

Se resultatet i tjenestedokumentet

Hvis du ikke har angitt IsPrivate egenskapen for den egendefinerte API-en, kan du nå hente tjenestedefinisjonen fra CSDL-$metadata dokumentet ved hjelp av en GET forespørsel, selv fra nettleseren. Hvis url-adressen for miljøet er https://yourorg.crm.dynamics.com, kan du skrive inn denne URL-adressen i adressefeltet i nettleseren for å hente $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Søk i resultatet for å finne navnet på den egendefinerte API-en. API-en som er definert ved hjelp av trinnene ovenfor, ser for eksempel slik ut:

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

Test den egendefinerte API-en

Når du har opprettet den egendefinerte API-en, kan du prøve den. Selv om du ikke har angitt en plugin-modultype til å definere hovedoperasjonen, kan du teste den nå for å bekrefte at du kan kalle den riktig. Eventuelle svaregenskaper returnerer standardverdien, for eksempel null. Mer informasjon: Aktivere egendefinerte API-er.

Oppdater den egendefinerte API-plugin-typen

Hvis du vil ha informasjon om hvordan du skriver et programtillegg for et egendefinert api, kan du se Skrive et programtillegg for den egendefinerte API-en.

Når du har registrert samlingen, må du angi verdien for plugin-type for den egendefinerte API-en du opprettet. Dette er en oppslagsegenskap, så du trenger bare å finne plugin-modultypen som representerer typen som ble opprettet da du registrerte samlingen.

Angi oppslaget for egendefinert API-plugin-type.

Når du har angitt plugin-typen, kan du teste den egendefinerte API-en for å bekrefte at de riktige resultatene returneres.

Andre måter å opprette egendefinerte API-er på

Registreringsverktøyet for programtillegg gir en egendefinert API-utforming. Mer informasjon: Opprette en egendefinert API ved hjelp av registreringsverktøyet for programtillegg

Det kan hende du har krav til å opprette et klientprogram som tillater oppretting av egendefinerte API-er utenfor utformeren. Siden dataene for egendefinerte API-er er lagret i tabeller, kan du opprette dem ved hjelp av kode. Mer informasjon: Opprett en egendefinert API med kode.

ALM-prosessen kan være bedre tjent med å opprette egendefinerte API-er ved å redigere løsningsfiler. Mer informasjon: Opprett en egendefinert API med løsningsfiler.

Se også

Opprett og bruk egendefinerte API-er
Opprette en egendefinert API ved hjelp av registreringsverktøyet for programtillegg
Opprette en egendefinert API med kode
Opprette en egendefinert API med løsningsfiler
Opprette dine egne meldinger