콘텐츠로 이동

개요


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

  • GET / POST 요청만 지원합니다
  • 리소스 지향 URL을 사용하여 API를 호출합니다
  • 상태 코드를 사용하여 요청 성공 또는 실패를 나타냅니다
  • 모든 요청은 JSON 구조를 반환합니다
  • Open API를 통해 프로그래밍 방식으로 Guance 플랫폼에 액세스합니다

지원 Endpoint

배포 유형 노드 이름 Endpoint
SaaS 배포 중국 리전 1(항저우) https://openapi.guance.com
SaaS 배포 중국 리전 2(닝샤) https://aws-openapi.guance.com
SaaS 배포 중국 리전 4(광저우) https://cn4-openapi.guance.com
SaaS 배포 중국 리전 6(홍콩) https://cn6-openapi.guance.one
SaaS 배포 해외 리전 1(오리건) https://us1-openapi.guance.com
SaaS 배포 유럽 리전 1(프랑크푸르트) https://eu1-openapi.guance.one
SaaS 배포 아시아 태평양 리전 1(싱가포르) https://ap1-openapi.guance.one
SaaS 배포 아시아 태평양 리전 2(싱가포르) https://ap2-openapi.guance.com
SaaS 배포 아프리카 리전 1(남아프리카) https://za1-openapi.guance.com
SaaS 배포 인도네시아 리전 1(자카르타) https://id1-openapi.guance.com
프라이빗 배포 플랜 프라이빗 배포 플랜 실제 배포된 Endpoint를 기준으로 합니다
파라미터 이름 유형 설명
Content-Type string application/json
DF-API-KEY string 호출자 식별자이며, 획득 방법은 API Key 관리를 참조하세요.

인증 방식

API는 API KEY를 인증 방식으로 사용하며, 각 요청은 요청 본문 Header의 DF-API-KEY 값을 유효성 검사 및 이번 요청의 워크스페이스 제한 근거로 사용합니다(해당 DF-API-KEY가 속한 워크스페이스를 사용).

현재 Open API에 표시된 모든 API는 자격 증명으로 API KEY(Header: DF-API-KEY)만 제공하면 됩니다. 자격 증명이 존재하고 유효하면 인증에 통과한 것으로 간주합니다.

공통 응답 구조

필드 유형 설명
code Number 응답의 상태 코드입니다. 다음 예시는 표준 JSON 응답이며, 다운로드 등의 API는 각 페이지 설명을 따릅니다.
content String, Number, Array, Boolean, JSON 반환되는 데이터로, 실제 반환되는 데이터 유형은 API 비즈니스와 관련이 있습니다.
pageInfo JSON API가 페이지네이션을 제공할 때 반환되며, 구체적인 계층은 각 API 설명을 따릅니다.
pageInfo.count Number 현재 페이지 데이터 수
pageInfo.pageIndex Number 페이지 번호
pageInfo.pageSize Number 페이지 크기
pageInfo.totalCount Number 조건에 부합하는 총 데이터 수
errorCode String 반환된 오류 상태 코드이며, 비어 있으면 오류가 없음을 의미합니다.
message String 반환된 오류 코드에 대응하는 구체적인 설명 정보입니다.
success Boolean API 성공 여부: 성공은 true, 실패는 false
traceId String traceId로, 각 요청 상황을 추적하는 데 사용됩니다.

문서 평가

이 페이지가 도움이 되었나요?