To use the Sigma Report APIs, you need to generate a personal access token. Access token is like password and you need to keep it confidential. Do not hardcode the access token in your application code.
Sigma enables you to generate tokens for the reports by using API Key or BASIC methodology.
1. Generating access tokens – API Key method
In order to generate access tokens using API key method, it is necessary to provide Client ID and client token details while passing the payload request.
Resource URL
POST Method Resource URL: http://localhost:9081/sigma/rest/reports/generate-token
Query Parameters are as follows:
Name | Description | Sample Values |
action | String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens. | GENERATE_TOKEN |
authType | Generating access token method. | APIKEY |
clientId | Client ID shared by the team. | 8HIG1002H6 |
clitentToken | Client Token provided by the team for report generation. | sample72695bf9-3932-4f60-88b5-2f-2hjd |
Response Parameters are as follows:
Parameter | Type | Description |
replyType | string | For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure. |
accessToken | string | Access token for using Sigma Report APIs. |
Sample Response
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}
|
2. Generating access tokens – BASIC method
In order to generate access tokens using BASIC method, it is necessary to provide the allotted Sigma username and password as payload.
Resource URL
POST Method Resource URL: http://localhost:9081/sigma/rest/reports/generate-token
Query Parameters are as follows:
Name | Description | Sample Values |
action | String indicating the action to be executed. GENERATE_TOKEN is the default action value for generating tokens. | GENERATE_TOKEN |
authType | Generating access token method. | BASIC |
username | Provided user name. | terrim |
password | Provided password. | canvas |
Response Parameters are as follows:
Parameter | Type | Description |
replyType | string | For reply type, the report status will be returned as 'SUCCESS' if generating token is successful or 'FAILURE' if generating token is a failure. |
accessToken | string | Access token for using Sigma Report APIs. |
Sample Response
{
"headerMap": {
"replyType": "success",
"success": "true",
"accessToken": " sample61d74837-2e77-4ede-a967-2c84b30-dws-b3b4f 7"
}
}
|