Dataverse im Web-API-Spielplatz erkunden und testen (Vorschau)

[Dieses Thema ist Teil der Dokumentation zur Vorabversion und kann geändert werden.]

Wichtig

Die Priorisierung für die Features Dataverse Accelerator, Monitor-Plug-Ins und API-Playground wurde aufgehoben; sie werden nicht als Features ausgeliefert. Informationen zur Verfügbarkeit von Vorschaufeatures finden Sie unter Power Apps Vorschauprogramm.

Der API-Playground ist ein vorautoriertes Softwaretesttool, mit dem Entwickler schnell und bequem mit der Microsoft Dataverse Web-API interagieren können.

Mit dieser Webanwendung können Entwicklungsfachkräfte verschiedene API-Endpunkte testen und damit experimentieren, ohne dass umfangreiche Einrichtungs- oder Authentifizierungsprozesse erforderlich sind. Darüber hinaus werden bestimmte verfügbare Aktionen und Links zur Dokumentation übersichtlich dargestellt, um das Lernen zu beschleunigen.

Verwenden Sie dieses Tool, um die Möglichkeiten der RESTful-API kennenzulernen, benutzerdefinierte Workflows zu testen und mehr.

Wichtig

• Dies ist eine Vorschauversion.
• Funktionen in der Vorschauversion sind nicht für den Produktionseinsatz gedacht und können eine eingeschränkte Funktionalität aufweisen. Diese Funktionen stehen vor dem offiziellen Release zur Verfügung, damit Kunden früher Zugriff darauf erhalten und Feedback geben können.

Schlüsselfunktionen

• Vorab authentifiziert: Der API-Playground ist vorab authentifiziert, sodass Entwicklungsfachkräfte sofort mit dem Testen und Experimentieren mit API-Endpunkten beginnen können.
• Webbasiert: Mit dem API-Playground können Entwicklungsfachkräfte schnell mit der Dataverse-Web-API interagieren, ohne dass eine umfangreiche Einrichtungen wie Softwaredownloads erfolgen oder ein Nicht-Microsoft-Konto eingerichtet werden müssen. Sie können auf das Tool über den Dataverse Beschleuniger zugreifen, eine Microsoft-App, die in allen neuen Dataverse-Umgebungen verfügbar ist und in jeder Umgebung installiert werden kann.
• Praktisch: Zeigt die verschiedenen Aktionen und Möglichkeiten im Dataverse-Web-API, sodass Sie schnell und einfach lernen, was möglich ist und wie es implementiert wird.

Anforderungen

Sie brauchen Zugriff auf Dataverse und Zugriff zur Abspielen der Dataverse-Beschleuniger-App. Mitglieder der Sicherheitsrolle für die Systemanpassung haben Zugriff zum Wiedergeben der App.

Starten Sie

Um mit der Arbeit mit dem API-Playground zu beginnen, spielen Sie den Dataverse Beschleuniger ab und wählen Sie dann die Seite API-Playground aus.

Anforderungen an die Dataverse-Web-API stellen

Wählen Sie auf dem Zielbildschirm den Anforderungstyp aus, indem Sie Erstellen auf einer der obersten Karten auswählen, um den Anforderungseditor zu öffnen.

Es stehen drei Anforderungstypen zur Verfügung:

Typ	Beschreibung
Benutzerdefinierte API	Dazu gehören alle Dataverse-Web-API-Aktionen, Funktionen von Microsoft oder alle öffentlichen benutzerdefinierten APIs, die in der Arbeitsumgebung registriert sind.
Sofort einsatzbereites Plug-in	Sofort-Plug-Ins werden als alle benutzerdefinierten Workflows klassifiziert, die als benutzerdefinierte API in der Umgebung mit einer zugehörigen FxExpression registriert sind.
OData-Anforderungen	Ermöglicht eine genauere Kontrolle über die Anforderungseingaben zum Senden von OData-Anforderungen.

Eine benutzerdefinierte API oder ein Sofort-Plug-In anfordern

Diese Anforderungsarten sind dafür gedacht, den Aufruf von in der Arbeitsumgebung verfügbaren Plug-Ins zu vereinfachen.

1. Wählen Sie eine Option aus der Hauptdropdownliste, in der die in der aktuellen Umgebung verfügbaren Plug-Ins angezeigt werden.

2. Wenn Parameter verfügbar sind, werden sie in der angezeigten Tabelle Abfrageparameter angezeigt. Geben Sie für erforderliche Parameter Werte an.

   Anmerkung

   Kontrollkästchen links neben jedem Parameter geben an, ob sie in der Anforderung enthalten sind. Bei den erforderlichen Parametern sind die Kontrollkästchen deaktiviert, bei den optionalen Parametern sind sie bearbeitbar.

3. Wählen Sie "Senden" aus.

4. Beobachten Sie die Antwort im unteren Bereich des Bildschirms.

Anmerkung

Die Schnittstelle bietet eine praktische Auflistung aller in der Umgebung verfügbaren Plug-Ins. Bei Auswahl werden die zugehörigen Parameter mit Datentypen angezeigt. Hinter den Kulissen erfolgt immer noch ein OData-Aufruf, aber die Schnittstelle vereinfacht den Aufbau des Aufrufs.

Eine OData-Anforderung stellen

OData-Anforderungen bieten mehr Optionen für Anforderungsparameter.

1. Wählen Sie in der ersten Dropdownliste die HTTP-Anforderungsmethode aus.

2. Geben Sie die Endpunkt-URL ein. Fügen Sie nur die Anforderungs-URL nach [OrgUrl]/api/data/v9.2/ ein

3. Fügen Sie Abfrageparameter mit einer der beiden Methoden hinzu:

   1. In der URL.

      1. Geben Sie nach dem Fragezeichen (?) in der URL den Abfrageparameterschlüssel ein.

      2. Geben Sie nach dem Schlüssel ein Gleichheitszeichen (=) ein.

      3. Geben Sie den Wert ein.

      Schlüssel und Werte werden automatisch in die Parametertabelle in der Schnittstelle eingetragen.

   2. Fügen Sie Abfrageparameter manuell hinzu, indem Sie + Parameter hinzufügen auswählen. Dadurch wird der Tabelle eine leere Parameterzeile hinzugefügt, in die Sie Werte eingeben können. Die URL wird dynamisch aktualisiert, wenn Werte eingegeben werden.

4. Geben Sie optional Text ein (wenn Sie andere Anforderungsmethoden als GET verwenden), indem Sie die Registerkarte Text auswählen und dann den Textwert in das Editorsteuerelement eingeben.

5. Wählen Sie "Senden" aus.

6. Achten Sie auf die Antwort im unteren Bereich.

Die Antwort anzeigen

Nachdem eine Anforderung gesendet wurde, wird die Antwort in der unteren Bildschirmhälfte angezeigt.

Der Antwortstatus bietet schnelle Metriken zur Anforderung:

• Statusmeldung
• Dauer (in Millisekunden)
• Größe (in Kilobytes)

Der Antworttext wird unterhalb des Antwortstatus angezeigt. Wählen Sie das Kopiersymbol aus, um den gesamten Antworttext in Ihre Zwischenablage zu kopieren.

FAQ

Welche Berechtigungen sind für den Zugriff auf das API-Playground-Tool erforderlich?

Sie brauchen Zugriff auf die Dataverse-Beschleuniger-App, um das Tool zu verwenden.

Verbindet sich das API-Playground-Tool nur mit der Dataverse-Web-API?

Ja, das API-Playground-Tool verbindet sich nur mit der Dataverse-Web-API. In dieser Schnittstelle kann zu keinen anderen Diensten eine Verbindung hergestellt werden.

Wie authentifiziert sich das API-Playground-Tool gegenüber der Dataverse-Web-API?

Das Tool verwendet das Authentifizierungstoken des angemeldeten Benutzenden, das zum Ausführen der Dataverse-Beschleunigeranwendung erforderlich ist.

Ist das API-Playground-Feature in allen Umgebungen verfügbar?

Das Feature wird über den Dataverse-Beschleuniger bereitgestellt und ist in allen Umgebungen verfügbar, in denen die App installiert ist. Die App wird in allen neuen Umgebungen automatisch installiert, kann aber auch in älteren Umgebungen mithilfe der Installationsanweisungen installiert werden.

Siehe auch

Erhalten Sie frühzeitig Vorschau-Features mit dem Dataverse-Beschleuniger (Vorschauversion)