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 at: \/v1/doc
   For example: https://external-api.guance.com/v1/doc

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

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

Service Configuration Options¶

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

# Configuration options for the external-api service
external:
  # The validity period of each request signature, in seconds, default 60 seconds
  timeliness: 60
  # Accessor identifier, corresponds to the `X-Df-Access-Key` value in the interface request header; non-empty string
  accessKey: ""
  # Key used to calculate the signature
  secretKey: ""