Skip to content

Commit 8c6b7cd

Browse files
committed
Revised for style and naming
1 parent b445085 commit 8c6b7cd

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

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

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Test and explore the Dataverse Web API
3-
description: Quickly and conveniently interact with Power Platform web APIs, including the Dataverse Web API in a pre-authenticated software testing tool.
3+
description: Quickly and conveniently interact with Power Platform web APIs, including the Dataverse Web API in a preauthenticated software testing tool.
44
author: denise-msft
55
ms.author: demora
66
ms.reviewer: matp
@@ -16,7 +16,7 @@ contributors:
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 preauthenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview).
2020

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

@@ -31,17 +31,17 @@ Use this tool to explore what's possible in the RESTful API, test user-defined w
3131
3232
## Key features
3333

34-
- Pre-authenticated: The API playground comes pre-authenticated, so developers can start testing and experimenting with API endpoints right away.
34+
- Preauthenticated: The API playground comes preauthenticated, so developers can start testing and experimenting with API endpoints right away.
3535
- 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 non-Microsoft account setup. You can access the tool from the Dataverse accelerator, a Microsoft app available in all new Dataverse environments and can be installed in any environment.
3636
- 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.
3737

3838
## Prerequisites
3939

40-
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).
40+
You must have [access to Dataverse](/power-apps/maker/data-platform/data-platform-entity-licenses), and [access to play the Dataverse accelerator app](./dataverse-accelerator.md#prerequisites-to-run-the-dataverse-accelerator). Members of the system customizer security role have access to play the app.
4141

4242
## Get started
4343

44-
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.
44+
To get started with the API playground, [play](dataverse-accelerator.md#play-the-dataverse-accelerator) the Dataverse accelerator and go to the API playground page.
4545

4646
![Run the API playground by selecting the feature card](media/api-play-run.svg)
4747

@@ -61,10 +61,10 @@ Three request types are presented:
6161

6262
These request types are designed to simplify calling plug-ins available in the working environment.
6363

64-
1. Select an option from the main dropdown, which presents the available plugins in the current environment.
65-
![Custom APIs are listed in the dropdown](./media/api-play-list-customapi.svg)
64+
1. Select an option from the main dropdown list, which presents the available plug-ins in the current environment.
65+
![Custom APIs are listed in the dropdown list](./media/api-play-list-customapi.svg)
6666

67-
1. If parameters are available, they are displayed in the **Query params** table that appears. Provide values for required parameters.
67+
1. If parameters are available, they're displayed in the **Query params** table that appears. Provide values for required parameters.
6868

6969
![Custom API parameters display automatically](./media/api-play-customapi-params.svg)
7070

@@ -73,9 +73,9 @@ These request types are designed to simplify calling plug-ins available in the w
7373
7474
1. Select **Send**.
7575

76-
Observe the [response](#view-the-response) in the lower section of the screen.
76+
1. Observe the [response](#view-the-response) in the lower section of the screen.
7777

78-
![Parameters are listed if registered](./media/api-play-response.svg)
78+
![Parameters are listed if registered](./media/api-play-response.svg)
7979

8080
> [!NOTE]
8181
> The interface provides a convenient listing of all available plug-ins 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.
@@ -84,25 +84,25 @@ Observe the [response](#view-the-response) in the lower section of the screen.
8484

8585
OData requests allow more options for request parameters.
8686

87-
1. Select the **HTTP request method** in the first dropdown list. <!-- start here-->
87+
1. Select the **HTTP request method** in the first dropdown list.
8888

89-
1. Type in the *endpoint Url*. Only include the request Url after `[OrgUrl]/api/data/v9.2/`
89+
1. Type in the *endpoint Url*. Only include the request URL after `[OrgUrl]/api/data/v9.2/`
9090

9191
1. Add *query parameters* using one of the two methods:
9292

93-
1. In the Url
94-
1. After the question mark (`?`) character in the Url, type in the query parameter key.
93+
1. In the URL.
94+
1. After the question mark (`?`) character in the URL, type in the query parameter key.
9595
![Key typed into Url after question mark](./media/api-play-key.svg)
96-
1. Type an equals (`=`) character after the key
97-
1. Type in the value
96+
1. Type an equals (`=`) character after the key.
97+
1. Type in the value.
9898
![Value typed into Url after the equals sign](./media/api-play-value.svg)
9999

100100
The keys and values will automatically populate the parameter table in the interface.
101101

102-
1. Manually add query parameters by clicking the **+ Add param** button. This will add an empty parameter row to the table that you can type values into. The Url will be updated dynamically as values are entered.
102+
1. Manually add query parameters by selecting **+ Add param**. This adds an empty parameter row to the table that you can type values into. The URL is updated dynamically as values are entered.
103103

104-
1. Optionally provide a Body (if using all request methods except GET) by selecting the Body tab, then entering the body value in the editor control.
105-
1. Click **Send**
104+
1. Optionally provide a body (if using all request methods except GET) by selecting the **Body** tab, and then enter the body value in the editor control.
105+
1. Select **Send**.
106106
1. Observe the [response](#view-the-response) in the lower section.
107107

108108
### View the response
@@ -117,26 +117,27 @@ The response status provides quick metrics on the request:
117117
- Duration (in milliseconds)
118118
- Size (in kilobytes)
119119

120-
The response body is displayed below the response status. You can click the copy icon to copy the response body to your clipboard.
120+
The response body is displayed below the response status. Select the copy icon to copy the response body to your clipboard.
121121

122122
### Save an API request
123123

124-
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.
124+
You can save requests for quick access later. Saved requests store the request details, such as the request method and endpoint for OData request, or the selected plug-in for custom API and instant plug-in, and the input parameters with associated values.
125+
126+
1. In the request screen, select **Save** in the top right corner of the page.
125127

126-
1. In the request screen, click the save button in the top right corner of the page.
127-
1. A dialog appears with form fields.
128+
A dialog appears with form fields.
128129
1. Provide a name for the request. A default value is provided based on the request details, but you can update the value.
129130
![Save request dialog](./media/api-play-save.svg)
130-
1. Click **Save**
131-
1. The saved request appears in the left rail of the screen.
132-
![Saved requests appear in the left rail of the screen](media/api-play-saved-requests.svg)
131+
1. Select **Save**.
132+
1. The saved request appears in the left pane of the screen.
133+
![Saved requests appear in the left pane of the screen](media/api-play-saved-requests.svg)
133134

134135
### Load a saved request
135136

136-
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.
137+
To load a saved request, select a request name. This loads the request screen with the request details filled in, including input parameters and values.
137138

138139
> [!NOTE]
139-
> You can only view saved requests that you have created.
140+
> You can only view saved requests that you've created.
140141
141142
## FAQs
142143

@@ -150,9 +151,9 @@ Yes, the API playground tool only connects to the Dataverse Web API. No other se
150151

151152
### How does the API playground tool authenticate to the Dataverse Web API?
152153

153-
The tool uses the authentication token of the logged in user that was required to play the Dataverse accelerator application.
154+
The tool uses the authentication token of the logged in user that is required to play the Dataverse accelerator application.
154155

155-
### Is the API playround feature available in all environments?
156+
### Is the API playground feature available in all environments?
156157

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

0 commit comments

Comments
 (0)