Set up a Postman environment

You can use Postman to connect to your Dynamics 365 for Customer Engagement apps instance and to compose Web API requests, send them, and view responses. Managing authentication challenges many people. This topic describes how to configure a Postman environment to work for both online and on-premises environments.

You can use a Postman environment to save a set of variables that you use to connect. These values can be accessed within Postman by using this syntax: {{name}}. For more information about Postman variables, see Postman Documentation > Variables.

Note

This topic contains information that is applicable only for the on-premises users of Customer Engagement apps.

The documentation that is applicable to Dynamics 365 for Customer Engagement app (online) users is now available in the PowerApps documentation at: Set up a Postman environment.

Prerequisites

Select the connection option that works for your environment:

Connect with an online environment

To connect with an online environment, see the information provided in this PowerApps Common Data Service topic: Connect with an online environment.

Connect with an on-premises environment

  1. Launch the Postman desktop application.
  2. Select the Environment Options gear icon in the top-right corner.
  3. In the Manage Environments dialog box, select the Add button to add a new environment.
  4. In the dialog box that opens, add a name for the environment. Then copy the following key-value pairs into the editing space.
Variable Name Value
url http://yourservername/yourorgname
version 9.0
webapiurl {{url}}/api/data/v{{version}}/

Create a new Postman environment to connect with On-premise instance

  1. Replace the instance URL placeholder value with your Dynamics 365 for Customer Engagement apps instance URL, and select Add to save the environment.
  2. Close the Manage environments dialog box.

Set credentials

  1. On the Authorization tab, select NTLM Authentication [Beta].
  2. Set the following values in the form:
    Username. Type the alias only; do not include the domain.
    Password. You have the option to show the password.
    Domain. You must set this if you are accessing the account from a different domain, although you can set it to ~ so that the default domain of the server is used.

Your authentication might look like this if you are logging in as an administrator.

Click on Authorization tab, and select NTLM Authentication

Test your connection

Create a new Web API request to test the connection with your Dynamics 365 for Customer Engagement apps instance. Use the WhoAmI function:

  1. Select GET as the HTTP method and add {{webapiurl}}WhoAmI in the editing space. WhoAmI function request
  2. Select Send to send this request.
  3. If your request is successful, you see the data from the WhoAmIResponse ComplexType that is returned by the WhoAmI Function.

See also

Use the Dynamics 365 for Customer Engagement Web API
Walkthrough: Register a Dynamics 365 for Customer Engagement app with Azure Active Directory