콘텐츠로 이동

개요¶

Guance External API는 간소화된 HTTP REST API입니다.

GET / POST 요청만 지원
리소스 기반 URL을 사용하여 API 호출
상태 코드로 요청 성공 또는 실패 표시
모든 요청은 JSON 구조 반환
External API는 프로그래밍 방식으로 Guance 플랫폼을 유지 관리합니다.

지원되는 Endpoint¶

배포 유형	노드 이름	Endpoint
배포 플랜	배포 플랜	실제 배포된 Endpoint 기준, 일반적으로 https://external-api.guance.com

API 문서 구성¶

API 문서 주소는 고정되어 있습니다: \/v1/doc
예: https://external-api.guance.com/v1/doc

API 문서 스위치 구성은 launcher의 core(네임스페이스: forethought-core) 구성에 있습니다. 구체적인 구성은 다음과 같습니다.

# API 문서
apiDocPageSwitch:
  # external api 문서 페이지 스위치: true는 활성화, false는 비활성화. 기본값은 false
  external: true

서비스 구성 항목¶

선택적 구성 항목은 launcher의 core(네임스페이스: forethought-core) 구성에 있습니다. 구체적인 선택적 구성은 다음과 같습니다.

# external-api 서비스 구성 항목
external:
  # 각 요청 서명의 유효 기간(초 단위), 기본값 60초
  timeliness: 60
  # 방문자 식별자, 요청 헤더의 `X-Df-Access-Key` 값에 해당하며 비어 있지 않은 문자열
  accessKey: ""
  # 서명 계산에 사용되는 비밀 키
  secretKey: ""

현재 저장소 내 초안 문서¶

템플릿 관리

참고: 템플릿 관리 문서는 현재 backend 저장소에 배포 전 초안으로 보관되어 있습니다. 기능이 완전히 개발되어 반복 배포 당일에 공식 도움말 문서 프로젝트 저장소로 동기화됩니다.