개요¶
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 배포 | 아프리카 리전 1 (남아프리카) | https://za1-openapi.guance.com |
| SaaS 배포 | 인도네시아 리전 1 (자카르타) | https://id1-openapi.guance.com |
| SaaS 배포 | 중동 리전 1 (아랍에미리트) | https://me1-openapi.guance.com |
| 배포 플랜 | 배포 플랜 | 실제 배포된 Endpoint 기준 |
공통 요청 헤더(Header)¶
| 파라미터명 | 유형 | 설명 |
|---|---|---|
| Content-Type | string | application/json |
| DF-API-KEY | string | 호출자 식별자, 획득 방법은 API Key 관리 참조 |
인증 방식¶
인터페이스는 API KEY를 인증 방식으로 사용합니다. 각 요청은 요청 본문 Header의 DF-API-KEY 값을 유효성 검사 및 해당 요청의 워크스페이스 제한 기준(이 DF-API-KEY가 속한 워크스페이스 사용)으로 사용합니다.
현재 Open API가 표시하는 모든 인터페이스는 API KEY(Header: DF-API-KEY)만 자격 증명으로 제공하면 됩니다. 자격 증명이 존재하고 유효하면 인증 통과로 간주합니다.
공통 응답 구조¶
| 필드 | 유형 | 설명 |
|---|---|---|
| code | Number | 반환된 상태 코드, HTTP 상태 코드와 동일하며 오류가 없으면 200으로 고정 |
| content | String, Number, Array, Boolean, JSON | 반환된 데이터, 실제 반환되는 데이터 유형은 해당 인터페이스의 비즈니스에 따라 다름 |
| pageInfo | JSON | 모든 목록 인터페이스 응답의 목록 페이지네이션 정보 |
| pageInfo.count | Number | 현재 페이지 데이터 수 |
| pageInfo.pageIndex | Number | 페이지네이션 페이지 번호 |
| pageInfo.pageSize | Number | 페이지당 크기 |
| pageInfo.totalCount | Number | 조건을 만족하는 총 데이터 수 |
| errorCode | String | 반환된 오류 상태 코드, 비어 있으면 오류 없음 |
| message | String | 반환된 오류 코드에 해당하는 구체적인 설명 정보 |
| success | Boolean | true로 고정, 인터페이스 호출 성공 의미 |
| traceId | Boolean | traceId, 각 요청 상황 추적에 사용 |