Opret en brugerdefineret API i Power Apps

I denne artikel forklares det, hvordan du opretter en brugerdefineret API i Power Apps til Microsoft Dataverse ved hjælp af en løsning. Følg disse trin for at definere egenskaber for anmodning og svar, teste den brugerdefinerede API og knytte dens plug-in-type. Hvis du ikke kender løsninger, skal du først læse Opret en løsning.

Din løsning skal være knyttet til en udgiver. Udgiveren har et bestemt tilpasningspræfiks tilknyttet. Du skal bruge et tilpasningspræfiks, når du opretter en brugerdefineret API, og dette præfiks skal være det samme præfiks, der bruges af udgiveren af din løsning. I følgende instruktioner bruges værdien sample som tilpasningspræfiks, fordi det er det, der er angivet for udgiveren.

Important

  • Der er nu en bedre oplevelse med at oprette brugerdefineret API. Du kan bruge en designer i plug-in-registreringsværktøjet. Du kan få flere oplysninger under Opret en brugerdefineret API ved hjælp af plug-in-registreringsværktøjet.
  • Du kan ikke ændre mange felter, der er relateret til oprettelse af brugerdefineret API, når du har oprettet dem. Planlæg omhyggeligt designet af den brugerdefinerede API, før du starter. Hvis du senere beslutter, at du skal ændre disse felter, skal du muligvis slette den eksisterende post og genoprette den brugerdefinerede API. Du kan få flere oplysninger i CustomAPI-tabeller.

Opret en brugerdefineret API-post

  1. I din løsning skal du vælge Ny>mere>anden>brugerdefineret API på rullelisten.

  2. Rediger felterne for at angive egenskaberne for din brugerdefinerede API. Angiv værdier for følgende felter. Du kan få flere oplysninger under Brugerdefinerede API-tabelkolonner.

    Du kan ikke angive værdier for Plug-in-typen , før du opretter plug-in'en. Du kan ændre denne værdi senere.

  3. Vælg Save. Formularen skal ligne følgende billede: Skærmbillede af den gemte brugerdefinerede API-formular med de konfigurerede egenskaber.

Opret anmodningsparametre

En brugerdefineret API kræver ikke parametre. Opret lige så mange parametre, du har brug for for at overføre de data, der er nødvendige for din logik.

  1. I din løsning skal du vælge Ny>mere>anden>brugerdefineret API-anmodningsparameter på rullelisten.

  2. Rediger felterne for at angive egenskaberne for din brugerdefinerede API-anmodningsparameter. Du kan få flere oplysninger under Tabelkolonner for CustomAPIRequestParameter.

  3. Vælg Save. Formularen skal ligne følgende billede:

    Skærmbillede af et eksempel på en brugerdefineret formular til API-anmodningsparameter.

Opret svaregenskaber

En brugerdefineret API, der repræsenterer en handling, kræver ikke svaregenskaber. En funktion skal have mindst én. Hvis handlingen lykkes, returneres et vellykket svar. Hvis det mislykkes, returneres der en fejl. Definer svaregenskaber for alle data, som din API returnerer.

Hvis du kun definerer en enkelt entity - eller EntityCollection-svaregenskab , er svaret af denne type. Hvis du definerer flere egenskaber eller en eller flere egenskaber af en simpel type, returnerer API'en en kompleks type, hvor hver svaregenskab er en egenskab af denne komplekse type.

Hvis dit brugerdefinerede API-entydige navn f.eks. er sample_CustomAPIExample, returnerer det en kompleks type med navnet sample_CustomAPIExampleResponse med egenskaber for hver svaregenskab, du definerer.

  1. I din løsning skal du vælge Ny>mere>anden>brugerdefineret API-svaregenskab på rullelisten.

  2. Rediger felterne for at angive egenskaberne for din brugerdefinerede API-svaregenskab. Du kan få flere oplysninger i Kolonner i tabellen CustomAPIResponseProperty.

  3. Vælg Save. Formularen skal ligne følgende billede:

    Skærmbillede af et eksempel på en brugerdefineret egenskabsformular for API-svar.

Se resultatet i tjenestedokumentet

Hvis du ikke angiver egenskaben IsPrivate for din brugerdefinerede API, kan du hente tjenestedefinitionen fra CSDL-$metadata dokument ved hjælp af en GET anmodning, selv fra din browser. Hvis URL-adressen til dit miljø er https://yourorg.crm.dynamics.com, kan du skrive denne URL-adresse i dit browseradressefelt for at hente $metadata: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Søg i resultatet for at finde navnet på den brugerdefinerede API. Den API, der er defineret ved hjælp af de foregående trin, ser f.eks. sådan ud:

<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 din brugerdefinerede API

Når du har oprettet din brugerdefinerede API, kan du prøve det. Selvom du ikke angiver en plug-in-type for at definere hovedhandlingen, kan du teste den nu for at bekræfte, at du kan kalde den korrekt. Alle svaregenskaber returnerer deres standardværdi, f.eks. null. Du kan få mere at vide under Aktivering af brugerdefinerede API'er.

Opdater den brugerdefinerede API-plug-in-type

Du kan få oplysninger om, hvordan du skriver en plug-in til en brugerdefineret API, under Skriv en plug-in til din brugerdefinerede API.

Når du har registreret din assembly, skal du angive værdien plug-intype for den brugerdefinerede API, du har oprettet. Denne værdi er en opslagsegenskab, så du skal blot finde den plug-in-type, der repræsenterer den type, der blev oprettet, da du registrerede assemblyen.

Skærmbillede af det opslag, der bruges til at angive den brugerdefinerede API-plug-in-type.

Når du har angivet plug-in-typen, kan du teste din brugerdefinerede API for at kontrollere, at de korrekte resultater returneres.

Andre måder at oprette brugerdefinerede API'er på

Værktøjet til registrering af plug-ins indeholder en brugerdefineret API-designer. Du kan få flere oplysninger under Opret en brugerdefineret API ved hjælp af plug-in-registreringsværktøjet.

Du har muligvis krav til at oprette et klientprogram, der tillader oprettelse af brugerdefinerede API'er uden for designeren. Da dataene for brugerdefinerede API'er er gemt i tabeller, kan du oprette dem ved hjælp af kode. Du kan finde flere oplysninger under Opret en brugerdefineret API med kode.

ALM-processen kan være bedre tjent med at oprette brugerdefinerede API'er ved at redigere løsningsfiler. Du kan få mere at vide under Opret en brugerdefineret API med løsningsfiler.

Se også

Oprette og bruge brugerdefineret API
Opret en brugerdefineret API ved hjælp af plug-in-registreringsværktøjet
Opret en brugerdefineret API med kode
Opret en brugerdefineret API med løsningsfiler
Opret dine egne meddelelser

  • Last updated on