Overview¶

Guance External API is a simplified HTTP REST API.

• Only GET / POST requests
• Use resource-oriented URLs to call the API
• Use status codes to indicate request success or failure
• All requests return JSON structures
• External API programmatically maintains the Guance platform

Supported Endpoints¶

API Documentation Configuration¶

1. The interface documentation address is fixed as: \/v1/doc
   For example: https://external-api.guance.com/v1/doc

2. The API documentation switch configuration is located in the core (namespace: forethought-core) configuration within launcher. The specific configuration is as follows

   # API Doc
   apiDocPageSwitch:
     # external api interface documentation page switch, true: indicates enabled; false: indicates disabled. Default is `false`
     external: true
   

Service Configuration Items¶

Optional configuration items are located in the core (namespace: forethought-core) configuration within launcher. The specific optional configurations are as follows

# Configuration items for the external-api service
external:
  # Validity period for each request signature, in seconds, default is 60 seconds
  timeliness: 60
  # Visitor identifier, corresponding to the `X-Df-Access-Key` value in the interface request header; non-empty string
  accessKey: ""
  # Secret key used for calculating the signature
  secretKey: ""

Draft Documents in the Current Repository¶

• Template Management

Note: The template management document is currently placed within the backend repository as a pre-release draft. Once the feature is fully developed and on the day of the iteration release, it will be synchronized to the official help documentation project library.