To explore the Smart API using Postman, you use a a Postman client for authentication and authorization with the Identity Provider (IdP). The steps depend on which IdP is used to secure Smart Completions:
-
Smart Completion authentication server
-
Smart API Manager
-
Another OAuth 2.0 IdP, such as Azure AD or Okta
Set up Postman to use the Smart Completion authentication server IdP
-
Request the JWT authentication token. To do so, send a POST request to the AuthenticateJWT URL and include your Smart Completions credentials in the body (or request payload).
https://<BASE_URL>/api/Authentication.asmx/AuthenticateJWT
For example:
-
The JWT token is included in the response. For example:
-
Copy the JWT Token from the JWT parameter in the response.
-
When sending a request to the Smart API, set the Authorization header parameter to the JWT Token.
If you're using the token for multiple calls, you can use variables for token values.
Set up Postman to use other IdPs
-
On the Authorization tab, define the configuration options. For more details on configuration options, refer to the Authorization section.
-
Click Get New Access Token.
-
Copy the access token.
-
When sending a request to the Smart API, set the Authorization header parameter to the JWT Token.
If you're using the token for multiple calls, you can use variables for token values.