Erstellen einer benutzerdefinierten API in Power Apps

  • Artikel
  • 2 Minuten Lesedauer

Beim Erstellen einer benutzerdefinierten API müssen Sie eine Lösung verwenden. Wenn Sie mit Lösungen nicht vertraut sind, lesen Sie zuerst Lösung erstellen.

Ihre Lösung muss einem Herausgeber zugeordnet sein. Dem Herausgeber ist ein bestimmtes Anpassungspräfix zugeordnet. Sie müssen beim Erstellen einer benutzerdefinierten API ein Anpassungspräfix verwenden. Dieses Präfix sollte das Gleiche sein, das vom Herausgeber Ihrer Lösung verwendet wird. Die folgenden Anweisungen verwenden den Wert sample als Anpassungspräfix, da es dasjenige ist, das für den Herausgeber festgelegt ist.

Wichtig

  • Es gibt jetzt eine bessere Erfahrung zum Erstellen von benutzerdefinierten APIs. Sie können einen Designer innerhalb des Plug-In-Registration Tools verwenden. Weitere Informationen: Erstellen Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool
  • Viele Felder zum Erstellen einer benutzerdefinierten API können nach dem Erstellen nicht mehr geändert werden. Sie sollten den Entwurf der benutzerdefinierten API sorgfältig planen, bevor Sie beginnen. Wenn Sie später entscheiden, dass Sie Dinge ändern müssen, nachdem Sie die Custom-API erstellt haben, müssen Sie möglicherweise den vorhandenen Datensatz löschen und die Custom-API neu erstellen. Überprüfen Sie hier die Informationen zu den Spalten, die nicht geändert werden können: CustomAPI-Tabellen

Einen benutzerdefinierten API-Datensatz erstellen

  1. Klicken Sie in Ihrer Lösung auf Neu > Mehr > Andere > Benutzerdefinierte API aus der Dropdown-Liste.

  2. Bearbeiten Sie die Felder, um die Eigenschaften Ihrer benutzerdefinierten API festzulegen. Sie müssen Werte für die folgenden Felder festlegen. Weitere Informationen finden Sie unter Benutzerdefinierte API-Tabellenspalten

    Sie können keine Werte für Plug-In-Typ festlegen, es sei denn, Sie haben das Plug-In bereits erstellt. Sie können dies später ändern.

  3. Klicken Sie auf Speichern. Ihr Formular sollte ungefähr so aussehen: Gespeichertes benutzerdefiniertes API-Formular.

Anforderungsparameter erstellen

Eine benutzerdefinierte API erfordert keine Parameter. Erstellen Sie so viele Parameter, wie Sie benötigen, um die für Ihre Logik erforderlichen Daten zu übergeben.

  1. Klicken Sie in Ihrer Lösung auf Neu > Mehr > Andere > Benutzerdefinierte API-Anforderungsparameter aus der Dropdown-Liste.

  2. Bearbeiten Sie die Felder, um die Eigenschaften Ihres benutzerdefinierten API-Anforderungsparameters festzulegen. Weitere Informationen finden Sie unter CustomAPIRequestParameter Tabellenspalten

  3. Klicken Sie auf Speichern. Das Formular sollte in etwa so aussehen:

    Beispiel eines benutzerdefinierten API-Anforderungsparameterformulars.

Antworteigenschaften erstellen

Eine benutzerdefinierte API, die eine Aktion darstellt, benötigt keine Antworteigenschaften. Eine Funktion muss mindestens einen aufweisen. Wenn der Vorgang erfolgreich ist, wird eine Erfolgsantwort zurückgegeben. Wenn dies fehlschlägt, wird ein Fehler zurückgegeben. Sie sollten Antworteigenschaften für alle Daten definieren, die Ihre API zurückgibt.

Wenn nur eine einzige Entity- oder EntityCollection-Antworteigenschaft definiert ist, wird die Antwort von diesem Typ sein. Wenn mehrere Eigenschaften oder eine oder mehrere Eigenschaften eines einfachen Typs vorhanden sind, gibt die API einen komplexen Typ zurück, wobei jede Antworteigenschaft eine Eigenschaft dieses komplexen Typs ist.

Zum Beispiel, wenn Ihr eindeutiger benutzerdefinierter API-Name sample_CustomAPIExample lautet, wird ein komplexer Typ namens sample_CustomAPIExampleResponse mit Eigenschaften für jede von Ihnen definierte Antworteigenschaft zurückgegeben.

  1. Klicken Sie in Ihrer Lösung auf Neu > Mehr > Andere > Benutzerdefinierte API-Antworteigenschaft aus der Dropdown-Liste.

  2. Bearbeiten Sie die Felder, um die Eigenschaften Ihrer benutzerdefinierten API-Antworteigenschaft festzulegen. Weitere Informationen finden Sie unter CustomAPIResponseProperty Tabellenspalten

  3. Klicken Sie auf Speichern. Das Formular sollte in etwa so aussehen:

    Benutzerdefiniertes API-Antworteigenschaftsformular.

Ergebnis im Dienstdokument beobachten

Wenn Sie die IsPrivate-Eigenschaft für Ihre benutzerdefinierte API nicht festgelegt haben, können Sie jetzt die Dienstdefinition aus dem CSDL $metadata-Dokument mithilfe einer GET-Anforderung, auch über Ihren Browser abrufen. Wenn die URL für Ihre Umgebung https://yourorg.crm.dynamics.com lautet, können Sie diese URL in das Adressfeld Ihres Browsers eingeben, um die $metadata abzurufen: https://yourorg.crm.dynamics.com/api/data/v9.1/$metadata.

Suchen Sie im Ergebnis nach dem Namen der benutzerdefinierten API. Die mit den obigen Schritten definierte API sieht beispielsweise folgendermaßen aus:

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

Benutzerdefinierte API testen

Nachdem Sie Ihre benutzerdefinierte API erstellt haben, können Sie sie ausprobieren. Auch wenn Sie keinen Plug-In-Typ zum Definieren des Hauptvorgangs festgelegt haben, können Sie sie jetzt testen, um sicherzustellen, dass Sie sie korrekt aufrufen. Alle Antworteigenschaften geben ihren Standardwert zurück, z. B. null. Weitere Informationen: Aufruf von Custom-APIs.

Aktualisieren Sie den benutzerdefinierten API-Plug-In-Typ

Informationen darüber, wie Sie ein Plug-In für eine Custom-API schreiben, finden Sie unter Schreiben Sie ein Plug-In für Ihre Custom-API.

Nachdem Sie Ihre Assembly registriert haben, müssen Sie den Plugin-Typ -Wert für die von Ihnen erstellte benutzerdefinierte API. Dies ist eine Sucheigenschaft. Sie müssen also nur den Plug-In-Typ suchen, der den Typ darstellt, der bei der Registrierung der Assembly erstellt wurde.

Legen Sie die Suche nach benutzerdefiniertem API-Plug-In-Typ fest.

Sobald Sie die Plugin-Typ eingestellt haben, können Sie Ihre benutzerdefinierte API testen, um sicherzustellen, dass die richtigen Ergebnisse zurückgegeben werden.

Andere Möglichkeiten zum Erstellen benutzerdefinierter APIs

Das Plugin-Registrierungstool bietet einen benutzerdefinierten API-Designer. Weitere Informationen: Erstellen Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool

Möglicherweise müssen Sie eine Clientanwendung erstellen, mit der benutzerdefinierte APIs außerhalb des Designers erstellt werden können. Da die Daten für Custom-APIs in Tabellen gespeichert werden, können Sie sie mit Code erstellen. Weitere Informationen finden Sie unter Eine benutzerdefinierte API mit Code erstellen.

Ihr ALM-Prozess kann besser bedient werden, indem Sie benutzerdefinierte APIs erstellen, indem Sie Lösungsdateien bearbeiten. Weitere Informationen finden Sie unter Eine benutzerdefinierte API mit Lösungsdateien erstellen.

Siehe auch

Benutzerdefinierte APIs erstellen und verwenden
Erstellen Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool
Eine benutzerdefinierte API mit Code erstellen
Eine benutzerdefinierte API mit Lösungsdateien erstellen
Eigene Nachrichten erstellen

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).