OAuth is an open-standard authorization protocol that provides applications with “secure designated access.” OAuth does not share password data but instead uses authorization tokens to prove an identity between consumers and service providers.
You can use OAuth to authenticate all your API requests to Comm100. OAuth provides a more secure way for your application to access your account data without requiring sensitive information like email and password to be sent with the requests.
Prerequisite
You must have admin-level access to the Postman application.
Step 1: Get the OAuth Access Token
To get the OAuth Access Token, follow these steps:
- Log in to Postman.
- Go to Home > Create New > HTTP Request.
- Select the POST method and provide the URL. While generating an access token, the API request should start with your platform domain followed by the curl command, which is different from other API requests.
For example, if your Control Panel domain is dash17.comm100.io, the API request should be https://dash17.comm100.io/oauth/token - Go to Body > x-www-form-urlencoded tab.
- Input the following Keys and their Values. To learn more about the OAuth token parameters, see OAuth Authentication.
For example:- email: XXXXXXXX
- password: XXXXX
- grant_type: password
- client_id: XXXXXX
- Click Send.
You get the OAuth Access Token to call APIs. - Copy the OAuth Access Token to your clipboard.
Step 2: Use the OAuth Access token to call an API
To call an API using the OAuth Access Token, follow these steps:
- Select the GET method and provide the API request URL. The following example requests a Get a single Chat API: https://api17.comm100.io/v4/livechat/chats/fdbf4b5c-ce71-442f-a84c-28ee83aa3922\
To learn about Comm100 API request URL, see Comm100 Restful API Guide. - Go to the Authorization tab and choose the authentication type as OAuth 2.0.
- Paste the OAuth Access Token in the Access Token field.
- Ensure that the Header Prefix field is Bearer.
- Click Send.
You get the response data successfully.