Een aangepaste API maken in Power Apps

Wanneer u een aangepaste API maakt, moet u een oplossing gebruiken. 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 aangepast voorvoegsel gebruiken bij het maken van een aangepaste API en dit voorvoegsel moet hetzelfde zijn als dat de uitgever van uw oplossing 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. Meer informatie: Een aangepaste API maken met het hulpprogramma voor registratie van invoegtoepassingen
• Veel velden met betrekking tot het maken van een aangepaste API kunnen niet worden gewijzigd nadat u ze hebt gemaakt. U moet het ontwerp van de aangepaste API zorgvuldig plannen voordat u begint. Als u later besluit dat u dingen moet wijzigen nadat u de aangepaste API hebt gemaakt, moet u mogelijk de bestaande record verwijderen en de aangepaste API opnieuw maken. Bekijk de informatie over de kolommen die hier niet kunnen worden gewijzigd: CustomAPI-tabellen

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. U moet waarden instellen 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 dit later wijzigen.

3. Selecteer Opslaan. Uw formulier ziet er ongeveer als volgt uit:

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-tabelkolommen voor meer informatie

3. Selecteer Opslaan. Uw formulier ziet er ongeveer als volgt uit:

   

Eventuele 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. U moet antwoordeigenschappen definiëren voor gegevens die door uw API worden geretourneerd.

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

Als uw aangepaste API Unieke naam 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 ziet er ongeveer als volgt uit:

   

Bekijk het resultaat in het servicedocument

Als u de eigenschap voor uw IsPrivate aangepaste API niet hebt ingesteld, kunt u de servicedefinitie nu 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 uw 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 bovenstaande 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 hebt ingesteld 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. Meer informatie: Aangepaste API's aanroepen.

Werk het aangepaste API-plugintype bij

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. Dit is een opzoekeigenschap, dus u hoeft alleen het invoegtoepassingstype te vinden dat het type vertegenwoordigt dat is gemaakt toen u de assembly registreerde.

Zodra 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. Meer informatie: Een aangepaste API maken met het hulpprogramma voor registratie van invoegtoepassingen

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 worden opgeslagen in tabellen, kunt u deze maken met behulp van code. Meer informatie: Een aangepaste API maken met code.

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

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