Call Manhattan Active® API using Postman
This guide will walk you through the steps for invoke an example REST API exposed by Manhattan Active®. The steps below will also assist you in establishing the authorization using OAuth v2.0 for invoking the API.
Before You Begin
- Download and install Postman or an equivalent tool of your choice. If you already have Postman installed, update it to v9.0.9 or newer.
- You will need the following information from the administrator who manages the implementation of Manhattan Active® applications for you:
- Application URL such as
https://<unique_id>.scp.manh.com. We will use
https://example.omni.manh.comfor this document.
- Authorization Server URL such as
https://<unique_id>-auth.scp.manh.com. We will use
https://example-auth.omni.manh.comfor this document.
- Values of
client_secretparameters as configured by your administrator. A default
client_idfor Postman is automatically created with value
postman.1.0.0. The administrator can look up the value of the respective
client_secret. We will use
aQsuVkh24SAp8MYras the value of
client_secretfor this document.
- A valid username and password for you to authenticate yourself. We will use
p455w0rdrespectively as the username and password for this document.
- Application URL such as
- As a sample REST API, we will use the endpoint that returns the details of your user. You may replace it with any other REST API that you have access to.
The step-by-step instructions below include the steps to obtain the authorization token for invoking the target REST API, followed by the invocation of the API.
Obtaining the Authorization Token
1. Open Postman and click on “New”
2. In the pop-up dialog, select “HTTP Request”
3. Click on the “Authorization” tab in the request section under “Untitled Request”
4. Click on the “Type” drop-down and select “OAuth v2.0”.
5. In the right-hand section, scroll down to the sub-section titled “Configure New Token”, and enter the values as shown below:
- Token Name:
- Grant Type: Authorization Code
- Callback URL:
- Auth URL:
- Access Token URL:
- Client ID:
- Client Secret:
- Scope: leave empty
- State: leave empty
- Client Authentication: Send as Basic Auth header
Click the “Get New Access Token” button to fetch the token.
6. Sign in with your username and password in the pop-up dialog. The pop-up may look different from the screenshot shown below depending on the Manhattan Active® application you are using.
7. Upon a successful login, Postman will display the access token in the UI, and give you an option to use it.
8. In the “Current Token” section of your REST API request, select
my-first-auth-token from the list to make use of the token you obtained.
Invoking the REST API call
1. To invoke the API to get the details of your username, set the URL to the value shown below:
Set the HTTP method to
GET. The inputs will look like this:
Verify that the “Access Token” is set to
my-first-auth-token in the “Current Token” section.
Click on the “Send” Button.
2. The API response in JSON format will be displayed in the section on the bottom
You can inspect the response content and headers by switching the response tabs.
With the access token, you can also invoke the API using
curl as a command line option instead of Postman:
curl -L -X GET -H 'Authorization: Bearer eyJhbGciOiJSUzI1Ni...' 'http://example.omni.manh.com/organization/api/organization/user/allDetails/userIdemail@example.com'
Was this page helpful?