Een aangepaste API maken in Power Apps

In dit artikel wordt uitgelegd hoe u een aangepaste API maakt in Power Apps voor Microsoft Dataverse met behulp van een oplossing. Volg deze stappen om aanvraag- en antwoordeigenschappen te definiëren, de aangepaste API te testen en het invoegtoepassingstype te koppelen. Als u niet bekend bent met oplossingen, leest u eerst Een oplossing maken.

Uw oplossing moet zijn gekoppeld aan een uitgever. Er is een specifiek aanpassingsvoorvoegsel aan de uitgever gekoppeld. U moet een aanpassingsvoorvoegsel gebruiken bij het maken van een aangepaste API. Dit voorvoegsel moet hetzelfde voorvoegsel zijn dat door de uitgever van uw oplossing wordt gebruikt. In de volgende instructies wordt de waarde sample gebruikt als het aanpassingsvoorvoegsel, omdat dit het voorvoegsel is dat is ingesteld voor de uitgever.

Belangrijk

• Er is nu een betere ervaring voor het maken van een aangepaste API. U kunt de ontwerpfunctie gebruiken binnen het Plug-in registratiehulpprogramma. Zie Een aangepaste API maken met behulp van het hulpprogramma voor registratie van invoegtoepassingen voor meer informatie.
• U kunt niet veel velden wijzigen die betrekking hebben op het maken van een aangepaste API nadat u ze hebt gemaakt. Plan het ontwerp van de aangepaste API zorgvuldig voordat u begint. Als u later besluit dat u deze velden moet wijzigen, moet u mogelijk de bestaande record verwijderen en de aangepaste API opnieuw maken. Zie CustomAPI-tabellen voor meer informatie.

Een aangepaste API-record maken

1. Selecteer in uw oplossing Nieuwe>meer>aangepaste>API in de vervolgkeuzelijst.

2. Bewerk de velden om de eigenschappen van uw aangepaste API in te stellen. Stel waarden in voor de volgende velden. Zie aangepaste API-tabelkolommen voor meer informatie.

   U kunt geen waarden instellen voor Plug-in Type voordat u de invoegtoepassing maakt. U kunt deze waarde later wijzigen.

3. Selecteer Opslaan. Uw formulier moet er ongeveer uitzien als in de volgende afbeelding:

Aanvraagparameters maken

Voor een aangepaste API zijn geen parameters vereist. Maak zo veel parameters als u nodig hebt om gegevens door te geven die nodig zijn voor uw logica.

1. Selecteer in uw oplossing Nieuw>Meer>Overige>Aangepaste API-verzoekparameter in de vervolgkeuzelijst.

2. Bewerk de velden om de eigenschappen van de aangepaste API-aanvraagparameter in te stellen. Zie CustomAPIRequestParameter Table Columns voor meer informatie.

3. Selecteer Opslaan. Uw formulier moet er ongeveer uitzien als in de volgende afbeelding:

   

Antwoordeigenschappen maken

Voor een aangepaste API die een actie vertegenwoordigt, zijn geen antwoordeigenschappen vereist. Een functie moet ten minste één hebben. Als de bewerking slaagt, wordt een succesvolle reactie geretourneerd. Als dit mislukt, wordt er een fout geretourneerd. Definieer antwoordeigenschappen voor gegevens die door uw API worden geretourneerd.

Als u slechts één entiteits - of EntityCollection-antwoordeigenschap definieert, is het antwoord van dat type. Als u meerdere eigenschappen of een of meer eigenschappen van een eenvoudig type definieert, retourneert de API een complex type waarbij elke antwoordeigenschap een eigenschap van dat complexe type is.

Als de unieke naam van uw aangepaste API bijvoorbeeld is sample_CustomAPIExample, wordt een complex type geretourneerd met de naam sample_CustomAPIExampleResponse met eigenschappen voor elke antwoordeigenschap die u definieert.

1. Selecteer in uw oplossing de eigenschap New>>>Custom API Response in de vervolgkeuzelijst.

2. Bewerk de velden om de eigenschappen van de aangepaste API-antwoordeigenschap in te stellen. Zie CustomAPIResponseProperty Table Columns voor meer informatie.

3. Selecteer Opslaan. Uw formulier moet er ongeveer uitzien als in de volgende afbeelding:

   

Bekijk het resultaat in het servicedocument

Als u de eigenschap voor uw IsPrivate aangepaste API niet instelt, kunt u de servicedefinitie ophalen uit het CSDL-$metadata-document met behulp van een GET aanvraag, zelfs vanuit uw browser. Als de URL voor uw omgeving is https://yourorg.crm.dynamics.com, kunt u deze URL typen in het adresveld van de browser om de $metadata op te halen: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Zoek in het resultaat naar de naam van de aangepaste API. De API die is gedefinieerd met behulp van de voorgaande stappen ziet er bijvoorbeeld als volgt uit:

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

Uw aangepaste API testen

Nadat u uw aangepaste API hebt gemaakt, kunt u deze proberen. Zelfs als u geen invoegtoepassingstype instelt om de hoofdbewerking te definiëren, kunt u deze nu testen om te controleren of u het correct kunt aanroepen. Alle antwoordeigenschappen retourneren hun standaardwaarde, zoals null. Zie Aangepaste API's aanroepen voor meer informatie.

Het aangepaste API-invoegtoepassingstype bijwerken

Zie Een invoegtoepassing schrijven voor uw aangepaste API voor informatie over het schrijven van een invoegtoepassing voor een aangepaste API.

Nadat u de assembly hebt geregistreerd, moet u de waarde invoegtoepassingstype instellen voor de aangepaste API die u hebt gemaakt. Deze waarde is een opzoekeigenschap, dus u hoeft alleen het invoegtoepassingstype te vinden dat het type vertegenwoordigt dat is gemaakt toen u de assembly registreerde.

Nadat u het type invoegtoepassing hebt ingesteld, kunt u uw aangepaste API testen om te controleren of de juiste resultaten worden geretourneerd.

Andere manieren om aangepaste API's te maken

Het hulpprogramma voor registratie van invoegtoepassingen biedt een aangepaste API-ontwerper. Zie Een aangepaste API maken met behulp van het hulpprogramma voor registratie van invoegtoepassingen voor meer informatie.

Mogelijk hebt u vereisten voor het maken van een clienttoepassing waarmee aangepaste API's buiten de ontwerpfunctie kunnen worden gemaakt. Omdat de gegevens voor aangepaste API's zijn opgeslagen in tabellen, kunt u deze maken met behulp van code. Zie Een aangepaste API met code maken voor meer informatie.

Uw ALM-proces kan beter worden bediend door aangepaste API's te maken door oplossingsbestanden te bewerken. Zie Een aangepaste API maken met oplossingsbestanden voor meer informatie.

Zie ook

Aangepaste API's maken en gebruiken
Een aangepaste API maken met behulp van het registratieprogramma voor invoegtoepassingen
Een aangepaste API maken met code
Een aangepaste API maken met oplossingsbestanden
Uw eigen berichten maken