GenerateAuthToken - Obtain Authentication Token
Obtain an authentication Token for subsequent API calls using an application secret key (appSecretKey).
Interface Description
Before calling any business interface in Open Text2Insight, you must first use this interface to obtain a login Token. This Token serves as the identity credential for all subsequent requests.
Usage Notes
- The appSecretKey is generated and distributed by the platform administrator in the backend.
- The Token has an expiration time; you must obtain a new one after it expires.
- Keep your appSecretKey secure to prevent leakage.
Request Method
Request Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| appSecretKey | Query | String | Yes | Application secret key, assigned by the administrator |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Whether the request was successful |
| data.token | String | Authentication Token, used for subsequent interface calls |
Request Example
Response Example
Successful response:
Error Codes
| Error Code | Description |
|---|---|
| success=false | appSecretKey is invalid or has expired |
Related Documentation
- Open API Overview — Interface list and general description
- Quick Start — Complete call flow after obtaining the Token
- CreateSession — Next step: create a session using the Token
