Erstellen Sie eine benutzerdefinierte API mit dem Plug-In-Registrierungstool

Das Plug-In-Registrierungstool (PRT) enthält einen Designer zum Erstellen einer benutzerdefinierten API. Das PRT ist eine Windows-Clientanwendung, die Teil der Entwicklertools ist, die Sie von NuGet herunterladen können. Informationen zum Herunterladen dieser Tools finden Sie unter Dataverse-Entwickler-Tools.

Verbindung mithilfe des Plugin Registration Tool herstellen

1. Nachdem Sie das Plugin Registration Tool heruntergeladen haben, öffnen Sie es durch Klicken auf PluginRegistration.exe.

2. Stellen Sie mit Neue Verbindung erstellen eine Verbindung zu Ihrer Instanz her.

3. Stellen Sie sicher, dass Office 365 ausgewählt ist.

4. Wenn Sie die Verbindung mit einem anderen Microsoft-Konto als dem derzeit verwendeten herstellen, klicken Sie auf Erweitert anzeigen und geben Sie Ihre Zugangsdaten ein. Ansonsten lassen Sie Melden Sie sich als aktueller Benutzer an ausgewählt.

5. Wenn Ihr Microsoft-Konto Zugriff auf mehrere Umgebungen bietet, wählen Sie Liste der verfügbaren Organisationen anzeigen aus.

   

6. Klicken Sie auf Anmeldung.

7. Wenn Sie Liste verfügbarer Organisationen anzeigen, wählen Sie die Organisation aus, die Sie verbinden möchten und klicken Sie auf Anmeldung.

8. Nachdem Sie verbunden sind, sehen Sie alle vorhandenen registrierten Plug-Ins, benutzerdefinierten Workflow-Aktivitäten und Datenanbieter.

   

Benutzerdefinierte API erstellen

Wählen Sie im Menü Registrieren den Befehl Neue benuzerdefinierte API. Dadurch wird das Formular zum Erstellen einer benutzerdefinierten API geöffnet.

Verwenden Sie die Informationen in der folgenden Tabelle, um die benutzerdefinierte API zu erstellen. Weitere Einzelheiten finden Sie unter Benutzerdefinierte API-Tabellenspalten

Wichtig

Einige Optionen können nicht geändert werden, nachdem Sie die benutzerdefinierte API gespeichert haben. Stellen Sie sicher, dass Sie den Zweck jeder Einstellung verstehen, die nicht geändert werden kann. Wenn Sie diese Einstellung später ändern müssen, müssen Sie die benutzerdefinierte API löschen und neu erstellen. Dadurch werden auch alle damit verknüpften Anforderungsparameter oder Antworteigenschaften gelöscht.

Label	Beschreibung des Dataflows	Knn geändert werden
Anzeigename	Ein lokalisierbarer Name.	Ja
Name des Dataflows	Ein freundlicher, nicht lokalisierbarer Name.	Ja
Solution	Erstellen Sie eine neue Lösung oder wählen Sie eine vorhandene aus. Durch Festlegen dieses Werts wird das entsprechende Anpassungspräfix für das Feld Einzigartiger Name festgelegt.	Ja
Eindeutiger Name	Der Name der benutzerdefinierten API. Dieser Wert sollte nur alphanumerische Zeichen und keine Leerzeichen enthalten. Der vollständige Name enthält das Anpassungspräfix, das durch Auswahl der Lösung bestimmt wird.	Nein
Beschreibung des Dataflows	Eine lokalisierbare Beschreibung. Zur Verwendung, wenn die Nachricht in einer App aufgerufen werden soll. Zum Beispiel als QuickInfo.	Ja
Assembly	Optional. Wählen Sie eine Assembly aus, die einen Plug-In-Typ enthält, der definiert, was die benutzerdefinierte API tut.	Ja
Plugin	Optional. Wählen Sie einen Plug-In-Typ innerhalb der ausgewählten Assembly aus. Sie können dies später einstellen.	Ja
Typ des zulässigen benutzerdefinierten Verarbeitungsschritts	Welche Arten von Verarbeitungsschritten Sie zulassen. Mehr Informationen: Wählen Sie einen benutzerdefinierten Verarbeitungsschritttyp aus	Nein
Bindungstyp	Welche Art von Entitätsbindung. Weitere Informationen finden Sie unter: Bindungstyp auswählen	Nein
Logischer Name der gebundenen Entität	Wenn Sie Bindungstyp Entität oder EntityCollection auswählen, sollten Sie den logischen Namen der Tabelle eingeben, die den Typ repräsentiert.	Nein
Name der Ausführungsberechtigung	Der Name einer Berechtigung, die steuert, ob jemand die API verwenden kann. Dies muss ein gültiger Name Wert aus der Tabelle Privileg sein. Mehr Informationen: Sichern Sie Ihre benutzerdefinierte API mit einem Privileg	Ja
Funktion	Ob eine Funktion erstellt werden soll. Mehr Informationen: Wann eine Funktion erstellen	Nein
Privat	Ob die benutzerdefinierte API privat sein sollte. Mehr Informationen: Wann Sie Ihre benutzerdefinierte API privat machen sollten	Ja

Hinweis

• Der Designer der benutzerdefinierten PRT-API macht die Eigenschaft Für Workflow aktiviert (WorkflowSdkStepEnabled) sichtbar. Wenn Sie eine benutzerdefinierte API erstellen möchten, die für Workflows funktioniert, müssen Sie eine andere Methode verwenden.
• Der Designer der benutzerdefinierten PRT-API macht die verwaltete Eigenschaft Ist anpassbar sichtbar. Sie können dies in Power Apps festlegen. Mehr Informationen Benutzerdefinierte API-Anpassung

Sie können weiterhin Parameteranfragen und Antworteigenschaften hinzufügen, oder die benutzerdefinierte API speichern und sie später hinzufügen.

Anforderungsparameter erstellen

Eine benutzerdefinierte API muss keine Anforderungsparameter haben. Beim Erstellen einer benutzerdefinierten API oder beim Bearbeiten einer vorhandenen API können Sie neue Anforderungsparameter erstellen, indem Sie auf + Anforderungsparameter hinzufügen klicken. Dadurch wird das Formular Parameter geöffnet.

Verwenden Sie die Informationen in der folgenden Tabelle, um die Anforderungsparameter zu erstellen. Weitere Einzelheiten finden Sie unter CustomAPIRequestParameter Tabellenspalten

Label	Beschreibung des Dataflows	Knn geändert werden
Anzeigename	Lokalisierbarer Anzeigename.	Ja
Name des Dataflows	Der primäre Name des benutzerdefinierten API-Anforderungsparameters. Diese Namenskonvention wird empfohlen, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen Einzigartiger Name haben: {Custom API Unique Name}.{Parameter UniqueName}	Ja
Eindeutiger Name	Dies ist der Name des Parameters, wenn Sie die benutzerdefinierte API aufrufen.	Nein
Art	Wählen Sie den Typ des Parameters aus. Boolesch DateTime Dezimal Entity EntityCollection EntityReference Float Ganzzahl Money Auswahlliste String StringArray GUID	Nein
Logischer Entitätsname	Wenn Entität, EntityCollection, oder EntityReference als Typ ausgewählt ist, können Sie die Tabelle festlegen.	Nein
Beschreibung des Dataflows	Lokalisierbare Beschreibung.	Ja
Ist optional	Ob ein Wert für den Parameter vom Aufrufer benötigt wird.	Nein

Antworteigenschaften erstellen

Eine benutzerdefinierte API für eine Aktion muss keine Antworteigenschaften haben. Beim Erstellen einer benutzerdefinierten API oder beim Bearbeiten einer vorhandenen API können Sie neue Antwortparameter erstellen, indem Sie auf + Antwortparameter hinzufügen klicken. Dadurch wird das Formular Parameter geöffnet.

Verwenden Sie die Informationen in der folgenden Tabelle, um die Antwortparameter zu erstellen. Weitere Einzelheiten finden Sie unter CustomAPIResponseProperty Tabellenspalten

Label	Beschreibung des Dataflows	Knn geändert werden
Anzeigename	Lokalisierbarer Anzeigename.	Ja
Name des Dataflows	Der primäre Name der benutzerdefinierten API-Antworteigenschaft. Diese Namenskonvention wird empfohlen, um diesen Parameter von anderen zu unterscheiden, die einen gemeinsamen haben: {Custom API Unique Name}.{Property UniqueName}	Ja
Eindeutiger Name	Dies ist der Name der Eigenschaft, die zurückgegeben wird, wenn Sie die benutzerdefinierte API aufrufen.	Nein
Art	Wählen Sie den Typ der Eigenschaft aus. Boolesch DateTime Dezimal Entity EntityCollection EntityReference Float Ganzzahl Money Auswahlliste String StringArray GUID	Nein
Logischer Entitätsname	Wenn Entität oder EntityReference als Typ ausgewählt ist, können Sie die Tabelle festlegen. Sie können keinen Logischen Entitätsname angeben, wenn Sie EntityCollection als Typ auswählen.	Nein
Beschreibung	Lokalisierbare Beschreibung.	Ja

Anzeigen einer Liste von benutzerdefinierten API

Um eine Liste der benutzerdefinierten APIs anzuzeigen, wählen Sie aus dem Menü Ansicht den Befehl Anzeige nach Nachricht.

Alle Nachrichten, die als benutzerdefinierte API erstellt wurden, erhalten das Präfix (benutzerdefinierte API).

Benutzerdefinierte API löschen

Wenn Sie eine Liste der benutzerdefinierten APIs anzeigen, wählen Sie diejenige aus, die Sie löschen möchten, und klicken Sie auf den Befehl Registrierung aufheben.

Oder klicken Sie mit der rechten Maustaste auf das Element und wählen Sie Registrierung aufheben aus dem Kontextmenü aus.

Aktualisieren Sie benutzerdefinierte API-Anforderungsparameter oder Antworteigenschaften

In der Liste der Parameter anfordern oder Antworteigenschaften, wählen Sie diese Spalte zum Bearbeiten aus:

Löschen Sie benutzerdefinierte API-Anforderungsparameter oder Antworteigenschaften

In der Liste der Parameter anfordern oder Antworteigenschaften, wählen Sie diese Spalte zum Löschen aus:

Nächste Schritte,

Wenn Sie die IsPrivate-Eigenschaft für Ihre benutzerdefinierte API nicht eingestellt haben, nachdem Sie Ihre benutzerdefinierte API erstellt haben, können Sie die Dienstdefinition aus dem CSDL-$-Metadatendokument mit einer GET-Anforderung abrufen, sogar von Ihrem Browser. 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 benutzerdefinierten API zu finden, und Sie werden die Aktion oder Funktion finden, die zusammen mit einem zugehörigen ComplexType erstellt wurde, um den Rückgabewert darzustellen. Zum Beispiel:

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

Auch wenn Sie kein Plugin für Ihre benutzerdefinierte API eingestellt haben, können Sie sie testen, um die Signatur zu überprüfen. Alle Antworteigenschaften geben ihre Standardwerte zurück, da es kein Plug-In zum Festlegen der Werte gibt. Weitere Informationen: Aufruf von Custom-APIs

Wenn Sie ein Plug-In hinzufügen, müssen Sie es schreiben und die Assembly registrieren. Aktualisieren Sie dann Ihre benutzerdefinierte API, um die Assembly und Plugin festzulegen, um anzugeben, welcher Code als Reaktion auf Ihre benutzerdefinierte API ausgeführt werden soll. Weitere Informationen siehe Plug-in für Ihre benutzerdefinierte API schreiben

Siehe auch

Benutzerdefinierte APIs erstellen und verwenden
Erstellen einer benutzerdefinierten API in Power Apps
Eine benutzerdefinierte API mit Code erstellen
Eine benutzerdefinierte API mit Lösungsdateien erstellen
Eigene Nachrichten erstellen
Benutzerdefinierte API-Tabellenspalten

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