Freigeben über

Erstellen Sie eine Custom-API in Power Apps.

  • Artikel

Wenn Sie eine Custom-API erstellen, 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 ein Anpassungspräfix verwenden, wenn Sie eine Custom-API erstellen, und dieses Präfix sollte das gleiche sein, das der Publisher Ihrer Lösung verwendet. 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 Möglichkeit, eine Custom-API zu erstellen. Sie können einen Designer innerhalb des Plug-In-Registration Tools verwenden. Weitere Informationen: Erstellen einer Custom-API mit dem Tool zur Plugin-Registrierung
  • Viele Felder im Zusammenhang mit dem Erstellen von Custom-API können nach dem Erstellen nicht mehr geändert werden. Sie sollten das Design der Custom-API sorgfältig planen, bevor Sie beginnen. Wenn Sie später feststellen, dass Sie etwas ä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

Erstellen eines Custom-API-Datensatzes

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

  2. Bearbeiten Sie die Felder, um die Eigenschaften Ihrer Custom-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

Für eine Custom-API sind keine Parameter erforderlich. 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 Ihrer Custom-API-Anfrageparameter festzulegen. Weitere Informationen finden Sie unter CustomAPIRequestParameter Tabellenspalten

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

    Beispiel für ein angepasstes Formular für API-Anfrageparameter:

Antworteigenschaften erstellen

Eine Custom-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.

Wenn Ihr Custom-API Unique Name beispielsweise sample_CustomAPIExample lautet, wird ein komplexer Typ mit dem Namen 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 Custom-API Response Property 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 Custom-API nicht gesetzt haben, können Sie jetzt die Service-Definition aus dem Dokument CSDL $metadata mit einer GET-Anfrage abrufen, sogar von Ihrem Browser aus. 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.

Durchsuchen Sie das Ergebnis, um den Namen der Custom-API zu finden. 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>

Testen Sie Ihre Custom-API

Jetzt, wo Sie Ihre Custom-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 Custom-API Plugin Typ

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

Nachdem Sie Ihre Assembly registriert haben, müssen Sie den Wert Plugin Typ für die von Ihnen erstellte Custom-API festlegen. 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.

Anpassen des Typs des Custom-API-Plugins Suchfeld.

Sobald Sie den Plugin Typ eingestellt haben, können Sie Ihre Custom-API testen, um zu überprüfen, ob die richtigen Ergebnisse zurückgegeben werden.

Andere Möglichkeiten, Custom-APIs zu erstellen

Das Tool zur Plugin-Registrierung stellt einen Custom-API-Designer zur Verfügung. Weitere Informationen: Erstellen einer Custom-API mit dem Tool zur Plugin-Registrierung

Möglicherweise müssen Sie eine Client-Anwendung erstellen, die das Erstellen von Custom-APIs außerhalb des Designers zulässt. Da die Daten für Custom-APIs in Tabellen gespeichert werden, können Sie sie mit Code erstellen. Weitere Informationen: Erstellen einer Custom-API mit Code.

Für Ihren ALM-Prozess ist es möglicherweise besser, Custom-APIs zu erstellen, indem Sie Lösungsdateien bearbeiten. Weitere Informationen: Erstellen Sie eine Custom-API mit Lösungsdateien.

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