You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
20
20
21
-

21
+

22
22
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.
24
24
25
25
Use this tool to explore what's possible in the RESTful API, test user-defined workflows, and more.
You must have access to the Dataverse Web API and the Dataverse accelerator app.
34
-
35
31
## Key features
36
32
37
33
- Pre-authenticated: The API playground comes pre-authenticated, so developers can start testing and experimenting with API endpoints right away.
38
34
- 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.
39
35
- 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.
40
36
41
-
## Installation
37
+
## Prerequisites
42
38
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).
44
40
45
41
## Get started
46
42
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.
48
44
49
-
### Make web API requests
45
+
### Make requests to the Dataverse Web API
50
46
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:
52
50
53
51
| Type | Description |
54
52
|-|-|
55
53
| 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. |
56
54
| 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). |
58
56
59
57
### Request a Custom API or instant low code plugin
60
58
61
59
These request types are designed to simplify calling plugins available in the working environment.
62
60
63
61
1. Select an option from the main dropdown, which presents the available plugins in the current environment.
64
-

62
+

63
+
64
+
1. If parameters are available, they are displayed in the *Query params* table that appears. Provide values for required parameters.
65
65
66
-
1. If parameters are available, they are displayed in the *Query parameters* table that appears.
66
+

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.
67
70
68
71
1. Click **Send**
69
72
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.
71
74
72
-

75
+

73
76
74
77
> [!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.
76
79
77
80
### Make an OData request
78
81
79
-
OData requests allow more control over the request parameters.
82
+
OData requests allow more options for request parameters.
80
83
81
84
1. Select the *HTTP request method* in the first dropdown.
82
85
@@ -86,10 +89,10 @@ OData requests allow more control over the request parameters.
86
89
87
90
1. In the Url
88
91
1. After the question mark (`?`) character in the Url, type in the query parameter key.
89
-

92
+

90
93
1. Type an equals (`=`) character after the key
91
94
1. Type in the value
92
-

95
+

93
96
94
97
The keys and values will automatically populate the parameter table in the interface.
95
98
@@ -103,41 +106,34 @@ OData requests allow more control over the request parameters.
103
106
104
107
After a request is sent, the response is displayed in the lower half of the screen.
The response status provides quick metrics on the request:
107
112
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.
115
118
116
119
### Save an API request
117
120
118
121
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.
119
122
120
123
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
+

127
+
1. Click **Save**
128
+
1. The saved request appears in the left rail of the screen.
129
+

127
130
128
131
### Load a saved request
129
132
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.
135
134
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.
141
137
142
138
## FAQs
143
139
@@ -151,16 +147,12 @@ Yes, the API playground tool only connects to the Dataverse Web API. No other se
151
147
152
148
### How does the API playground tool authenticate to the Dataverse Web API?
153
149
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.
155
151
156
152
### Is the API playround feature available in all environments?
157
153
158
154
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).
159
155
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
-
164
156
## See also
165
157
166
158
[Get preview features early with the Dataverse accelerator (preview)](dataverse-accelerator.md)
Copy file name to clipboardExpand all lines: powerapps-docs/maker/data-platform/dataverse-accelerator/dataverse-accelerator.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,8 @@ You must have the following privileges in your Dataverse environment:
58
58
| Feature | Description |
59
59
| -- | -- |
60
60
|[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). |
0 commit comments