Skip to content

Commit 39b2d46

Browse files
committed
Updated images and added link from DV page
1 parent e59158a commit 39b2d46

20 files changed

+129
-134
lines changed

powerapps-docs/maker/data-platform/dataverse-accelerator/api-playground.md

Lines changed: 44 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,77 +6,80 @@ ms.author: demora
66
ms.reviewer: matp
77
ms.service: powerapps
88
ms.topic: how-to
9-
ms.date: 05/13/2024
9+
ms.date: 05/24/2024
1010
ms.custom: template-how-to
1111
contributors:
1212
- dikamath
1313
---
1414

15-
# Test and explore the Dataverse Web API (preview)
15+
# Explore and test Dataverse in the Web API playground (preview)
1616

1717
[!INCLUDE [cc-beta-prerelease-disclaimer](../../../includes/cc-beta-prerelease-disclaimer.md)]
1818

19-
The API playground is a pre-authenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview).
19+
The API playground is a pre-authenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview).
2020

21-
![API playground home screen](./media/api-playground/api-play-landing.svg)
21+
![API playground home screen](./media/api-play-landing.svg)
2222

23-
This web application allows developers to test and experiment with different API endpoints without the need for extensive setup or authentication processes. It also conveniently presents certain available actions, examples, and links to documentation for faster learning.
23+
This web application allows developers to test and experiment with different API endpoints without the need for extensive setup or authentication processes. It also conveniently presents certain available actions and links to documentation for faster learning.
2424

2525
Use this tool to explore what's possible in the RESTful API, test user-defined workflows, and more.
2626

2727
> [!IMPORTANT]
2828
> - This is a preview feature.
2929
> - [!INCLUDE [cc-preview-features-definition](../../../includes/cc-preview-features-definition.md)]
3030
31-
## Prerequisites
32-
33-
You must have access to the Dataverse Web API and the Dataverse accelerator app.
34-
3531
## Key features
3632

3733
- Pre-authenticated: The API playground comes pre-authenticated, so developers can start testing and experimenting with API endpoints right away.
3834
- Web-based: With the API playground, developers can quickly interact with the Dataverse Web API without the need for extensive setup like software downloads or third party account setup. You can access the tool from the Dataverse Accelerator, a first party app available in all new Microsoft Dataverse environments and can be installed in any environment.
3935
- Convenient: Presents the various actions and capabilities available in the Dataverse Web API, making it easy to quickly learn what's possible and how to implement it.
4036

41-
## Installation
37+
## Prerequisites
4238

43-
This feature is available in the Dataverse accelerator app. Go to the [Dataverse accelerator article](./dataverse-accelerator.md) for installation instructions.
39+
You must have [access to Dataverse](/power-apps/maker/data-platform/data-platform-entity-licenses), and [access to run the Dataverse accelerator app](./dataverse-accelerator.md#prerequisites-to-run-the-dataverse-accelerator).
4440

4541
## Get started
4642

47-
To get started with the API playground, simply run or install the Dataverse Accelerator and navigate to the API playground page to start interacting with the Dataverse Web API.
43+
To get started with the API playground, [run](dataverse-accelerator.md#play-the-dataverse-accelerator) the Dataverse accelerator and navigate to the API playground page.
4844

49-
### Make web API requests
45+
### Make requests to the Dataverse Web API
5046

51-
Choose the desired request type to open the request screen. The input options are determined based on the request type. There are three request types presented:
47+
On the landing screen, choose the request type to open the request editor by clicking the 'Create' button on any of the top cards.
48+
49+
Three request types are presented:
5250

5351
| Type | Description |
5452
|-|-|
5553
| Custom API | This includes any Microsoft Dataverse Web API first party [actions](/power-apps/developer/data-platform/webapi/use-web-api-actions), [functions](/power-apps/developer/data-platform/webapi/use-web-api-functions), or any public [user-defined Custom APIs](/power-apps/developer/data-platform/custom-api) registered in the working environment. |
5654
| Instant low code plugin | [Instant low code plugins](/power-apps/maker/data-platform/low-code-plug-ins?tabs=instant) are classified as any user-defined workflows registered as a Custom API in the environment with a related FxExpression. |
57-
| OData request | Provides an interface with more paramaters than the other types, allowing more granular control to create and send [OData requests](/power-apps/developer/data-platform/webapi/perform-operations-web-api). |
55+
| OData request | Allows more granular control over the request inputs to send [OData requests](/power-apps/developer/data-platform/webapi/perform-operations-web-api). |
5856

5957
### Request a Custom API or instant low code plugin
6058

6159
These request types are designed to simplify calling plugins available in the working environment.
6260

6361
1. Select an option from the main dropdown, which presents the available plugins in the current environment.
64-
![Custom APIs are listed in the dropdown](./media/api-playground/api-play-list-customapi.svg)
62+
![Custom APIs are listed in the dropdown](./media/api-play-list-customapi.svg)
63+
64+
1. If parameters are available, they are displayed in the *Query params* table that appears. Provide values for required parameters.
6565

66-
1. If parameters are available, they are displayed in the *Query parameters* table that appears.
66+
![Custom API parameters will dusplay automatically](./media/api-play-customapi-params.svg)
67+
68+
> [!NOTE]
69+
> Checkboxes to the left of each parameter indicate whether they are included in the request. Required parameters have disabled checkboxes, while optional parameters have editable ones.
6770
6871
1. Click **Send**
6972

70-
Observe the [response](#view-the-response) in the lower section of the screen.
73+
1. Observe the [response](#view-the-response) in the lower section of the screen.
7174

72-
![Parameters are listed if registered](./media/api-playground/api-play-response.svg)
75+
![Parameters are listed if registered](./media/api-play-response.svg)
7376

7477
> [!NOTE]
75-
> The interface provides convenience by listing the available plugins and auto-populating the associated parameters definitions. However, behind the scenes an OData call is still being made.
78+
> The interface provides a convenient listing of all available plugins in the environment. When selected, the associated parameters with data types are presented. Behind the scenes an OData call is still being made, but the interface simplifies the construction of the call.
7679
7780
### Make an OData request
7881

79-
OData requests allow more control over the request parameters.
82+
OData requests allow more options for request parameters.
8083

8184
1. Select the *HTTP request method* in the first dropdown.
8285

@@ -86,10 +89,10 @@ OData requests allow more control over the request parameters.
8689

8790
1. In the Url
8891
1. After the question mark (`?`) character in the Url, type in the query parameter key.
89-
![Key typed into Url after question mark](./media/api-playground/api-play-key.svg)
92+
![Key typed into Url after question mark](./media/api-play-key.svg)
9093
1. Type an equals (`=`) character after the key
9194
1. Type in the value
92-
![Value typed into Url after the equals sign](./media/api-playground/api-play-value.svg)
95+
![Value typed into Url after the equals sign](./media/api-play-value.svg)
9396

9497
The keys and values will automatically populate the parameter table in the interface.
9598

@@ -103,41 +106,34 @@ OData requests allow more control over the request parameters.
103106

104107
After a request is sent, the response is displayed in the lower half of the screen.
105108

106-
![OData response](./media/api-playground/api-play-odata-response.svg)
109+
![OData response](./media/api-play-odata-response.svg)
110+
111+
The response status provides quick metrics on the request:
107112

108-
1. The response status provides quick metrics on the request:
109-
1. Status message (e.g., "200 Success")
110-
1. Duration (in milliseconds)
111-
1. Size (in kilobytes)
112-
1. The response body is displayed in an editor control below the response status.
113-
1. View in prettified JSON or in raw form by selecting the mode in the dropdown.
114-
2. Click the copy icon to copy the response body to clipboard.
113+
- Status message
114+
- Duration (in milliseconds)
115+
- Size (in kilobytes)
116+
117+
The response body is displayed below the response status. You can click the copy icon to copy the response body to your clipboard.
115118

116119
### Save an API request
117120

118121
You can save requests for quick access later on. Saved requests will store the request details (such as the request method and endpoint for OData request, or the selected plugin for Custom API and instant low code plugin), and the input parameters with associated values.
119122

120123
1. In the request screen, click the save button in the top right corner of the page.
121-
1. A side rail will appear inline on the right side of the page with form fields
122-
1. Provide a name for the request. A default value is entered based on the request details, but you can update the value.
123-
1. Optionally choose a folder to save the request under.
124-
1. Click Save
125-
126-
The saved request is created and should appear in the left rail of the screen.
124+
1. A dialog appears with form fields.
125+
1. Provide a name for the request. A default value is provided based on the request details, but you can update the value.
126+
![Save request dialog](./media/api-play-save.svg)
127+
1. Click **Save**
128+
1. The saved request appears in the left rail of the screen.
129+
![Saved requests appear in the left rail of the screen](media/api-play-saved-requests.svg)
127130

128131
### Load a saved request
129132

130-
Saved requests are displayed in the left rail of any screen. You can only view saved requests that you have created.
131-
132-
To load a saved request, simply select a request name by clicking on the list item. This will load the request screen with the request details filled in.
133-
134-
### Create a folder
133+
To load a saved request, select a request name. This will load the request screen with the request details filled in, including input parameters and values.
135134

136-
Use folders to manage saved requests into groups.
137-
138-
1. In the left rail, click the + (new) button > Create folder
139-
1. In the dialog that appears, provide a name for the folder
140-
1. Click save
135+
> [!NOTE]
136+
> You can only view saved requests that you have created.
141137
142138
## FAQs
143139

@@ -151,16 +147,12 @@ Yes, the API playground tool only connects to the Dataverse Web API. No other se
151147

152148
### How does the API playground tool authenticate to the Dataverse Web API?
153149

154-
The tool uses the auth token of the logged in user via the Power Platform framework, which is required for playing any application in Power Apps.
150+
The tool uses the authentication token of the logged in user that was required to play the Dataverse accelerator application.
155151

156152
### Is the API playround feature available in all environments?
157153

158154
The feature is delivered through the Dataverse accelerator and is available in all environments that have the app installed. The app is automatically installed in all new environments, but can also be installed in older environments by following the [install instructions](dataverse-accelerator.md#install-the-dataverse-accelerator).
159155

160-
### How do I update or delete folders?
161-
162-
Use the table explorer to manage folders as rows in the **API Request Folder** table in the maker portal (make.powerapps.com). We will provide in-app experiences to manage the folders in subsequent updates.
163-
164156
## See also
165157

166158
[Get preview features early with the Dataverse accelerator (preview)](dataverse-accelerator.md)

powerapps-docs/maker/data-platform/dataverse-accelerator/dataverse-accelerator.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ You must have the following privileges in your Dataverse environment:
5858
| Feature | Description |
5959
| -- | -- |
6060
| [Low-code plug-ins](../low-code-plug-ins.md) | Reusable, real-time workflows that execute a specific set of commands within Dataverse. Low-code plug-ins run server-side and are triggered by personalized event handlers, defined in Power Fx. |
61-
| [Plug-in monitoring](plugin-monitoring.md) | A modern interface to surface the existing plug-in trace log table in Dataverse environments, designed for developing and debugging Dataverse plug-ins and custom APIs. |
61+
| [Plug-in monitor](plugin-monitoring.md) | A modern interface to surface the existing plug-in trace log table in Dataverse environments, designed for developing and debugging Dataverse plug-ins and custom APIs. |
62+
| [API playground](api-playground.md) | a pre-authenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview). |
6263

6364
## Manage the Dataverse accelerator app
6465

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-customapi-params.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-key.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-landing.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-list-customapi.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-odata-response.svg

Lines changed: 10 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-response.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-save.svg

Lines changed: 9 additions & 0 deletions
Loading

powerapps-docs/maker/data-platform/dataverse-accelerator/media/api-play-saved-requests.svg

Lines changed: 10 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)