Overview¶
Guance Open API is a simplified HTTP REST API.
- Only GET / POST requests
- Uses resource-oriented URLs to call the API
- Uses status codes to indicate request success or failure
- All requests return JSON structures
- Open API provides programmatic access to the Guance platform
Supported Endpoints¶
| Deployment Type | Node Name | Endpoint |
|---|---|---|
| SaaS Deployment | China 1 (Hangzhou) | https://openapi.guance.com |
| SaaS Deployment | China 2 (Ningxia) | https://aws-openapi.guance.com |
| SaaS Deployment | China 4 (Guangzhou) | https://cn4-openapi.guance.com |
| SaaS Deployment | China 6 (Hong Kong) | https://cn6-openapi.guance.one |
| SaaS Deployment | Overseas 1 (Oregon) | https://us1-openapi.guance.com |
| SaaS Deployment | Europe 1 (Frankfurt) | https://eu1-openapi.guance.one |
| SaaS Deployment | Asia Pacific 1 (Singapore) | https://ap1-openapi.guance.one |
| SaaS Deployment | Asia Pacific 2 (Singapore) | https://ap2-openapi.guance.com |
| SaaS Deployment | Africa 1 (South Africa) | https://za1-openapi.guance.com |
| SaaS Deployment | Indonesia 1 (Jakarta) | https://id1-openapi.guance.com |
| Private Deployment | Private Deployment | Depends on the actual deployed Endpoint |
Common Request Headers¶
| Parameter | Type | Description |
|---|---|---|
| Content-Type | string | application/json |
| DF-API-KEY | string | Caller identifier. For how to obtain it, see API Key Management |
Authentication¶
The interface uses an API KEY as the authentication method. Each request uses the value of DF-API-KEY in the request header as the validity check and as the basis for limiting the workspace of the request (using the workspace to which this DF-API-KEY belongs).
All interfaces shown in the current Open API only require an API KEY (Header: DF-API-KEY) as a credential. If the credential exists and is valid, authentication is considered passed.
Common Response Structure¶
| Field | Type | Description |
|---|---|---|
| code | Number | Returned status code, consistent with the HTTP status code; fixed at 200 when there is no error |
| content | String, Number, Array, Boolean, JSON | Returned data. The specific data type returned depends on the business logic of the actual API |
| pageInfo | JSON | Pagination information returned by all list APIs |
| pageInfo.count | Number | Number of records on the current page |
| pageInfo.pageIndex | Number | Page number |
| pageInfo.pageSize | Number | Page size |
| pageInfo.totalCount | Number | Total number of records matching the criteria |
| errorCode | String | Returned error status code; empty indicates no error |
| message | String | Specific description corresponding to the returned error code |
| success | Boolean | Whether the request succeeded: true on success, false on failure |
| traceId | String | traceId, used to trace each request |