# 오픈 API
이 문서에 기록된 내용은 TE의 고급 사용 기능에 속하며, 더 기술적인 세부 정보가 포함되어 있으며, 관련 경험이 있는 개발자가 참조하기에 적합합니다. 문서 내용에 대해 질문이 있는 경우, 저희 매니저에게 문의해주세요.
TE는 분석 UI 뿐만 아니라, 풍부한 API도 제공하고 있습니다.
- 모듈 검색 API：모델 쿼리 인터페이스를 통해 데이터를 가져옵니다.
- 데이터 커스텀 쿼리 API：SQL을 통해 데이터를 가져옵니다.
- 유저 코호트와 태그 API：주로 유저 코호트와 태그의 구성에 사용됩니다.
- 참조 테이블 API：주로 참조 테이블의 구성에 사용됩니다.
- 데이터 테이블 API：주로 데이터 테이블의 조작에 사용됩니다.
- SQL 생성 API：주로 SQL 생성에 사용됩니다.
- 메타데이터 관리 API：주로 메타데이터의 관리에 사용됩니다.
- 대시보드 & 리포트 API：주로 대시보드 & 리포트 데이터의 관리에 사용됩니다.
- 유저 관리 API：주로 유저 관리에 사용됩니다.
- 프로젝트 관리 API：주로 프로젝트 데이터의 관리에 사용됩니다.
- 지표 쿼리 API：지표 리스트를 쿼리하거나, 지표 인터페이스를 통해 데이터를 가져옵니다.
# 호출 방법
# 쿼리 키 생성
Open API를 사용하기 전에 프로젝트 키를 먼저 생성해야 합니다. 프로젝트 키에는 두 가지 유형이 있습니다. 프로젝트 키를 생성하는 명령은 ta-tool에서 실행해야 합니다.
TA 서버에 로그인하여 "su - ta" 명령을 실행하여 ta 사용자로 전환한 다음 ta-tool을 실행합니다.
루트 키 생성
ta-tool generate_root_secret
- 이 키는 모든 프로젝트에 적용됩니다.
단일 프로젝트용 키 생성
ta-tool generate_api_secret -appid TEST-APPID
- 전달된 인자는 해당 프로젝트의 APPID입니다. 생성된 키는 해당 프로젝트에만 사용될 수 있습니다.
참고: 같은 프로젝트나 루트 키가 반복 실행될 경우, 새 키가 생성되며 이전 키는 무효화됩니다.
# API 호출 규칙
API는 HTTP GET 또는 POST 방식을 사용하여 호출 요청을 제출하며, 호출 URL은 다음과 같습니다:
http://$HOST:8992/$API_PATH?token=$API_SECRET
$HOST는 서버 주소를 의미하며, 보통 ta2입니다. $API_PATH는 특정 API 경로를 의미하며, 예를 들어 open/event-analyze입니다. $API_SECRET는 키입니다.
API는 HTTP GET 또는 POST 방식을 사용하여 호출 요청을 제출합니다. POST 요청 메시지 본문은 JSON 형식입니다. 자세한 매개변수 구성은 관련 문서를 확인해주세요.
응답 메시지 본문은 JSON 형식이며, 기본 구조는 다음과 같습니다.
{
"return_code": 0,
"return_message": "성공",
"data": {...},
"stackMessage": "",
"showStackMessage": false
}
필드 | 설명 |
|---|---|
| return_code | 반환 코드 0은 성공을 의미하며, 그 외는 실패를 나타냅니다(자세한 지침은 다음 표에 나와 있습니다) |
| return_message | 반환 메시지 |
| data | 호출 결과 데이터 |
| stackMessage | 실패 시 비정상 스택 |
| showStackMessage | TE 제품의 프론트 엔드에서 사용됩니다(OpenAPI 호출 시 이 필드를 무시할 수 있음); 비정상 스택의 복사 버튼을 표시할지 여부를 나타냅니다 |
return_code 반환 코드 세부 사항
Return code | 반환 코드 지침 |
|---|---|
0 | 성공적으로 실행됨 |
-1 | 실행에 실패함 |
-1001 | 로그인하지 않음 |
-10012 | 로그인 실패 |
-10013 | 로그아웃 실패 |
-1002 | 계정이 잠겼습니다. 관리자에게 문의하여 문제를 해결하세요 |
-1003 | 사용자 이름 또는 비밀번호 오류. 확인 후 다시 로그인하세요 |
-1004 | 문제가 발생했습니다. 나중에 다시 시도하거나 저희에게 문의하세요 |
-1005 | 요청이 너무 빈번합니다. 나중에 다시 시도하세요 |
-1006 | 운영 권한이 없습니다 |
-1007 | SSO 로그인 실패 |
-1008 | 매개변수 오류 |
-1009 | 사용자 이름이 존재하지 않음 |
-1010 | 불법적인 운영 |
-1011 | 데이터 준비되지 않음 |
-1012 | 현재 데이터 없음 |
-1013 | 데이터 준비 중 |
-1014 | 잘못된 접근 |
-1015 | 이미 존재함 |
-1020 | 전화번호가 잘못됨 |
-1021 | 이 프로젝트의 멤버 이미 존재함 |
-1022 | 요청 취소됨 |
-1023 | 대상 객체가 존재하지 않음 |
-1099 | 커스텀 이벤트 표현이 불완전하거나 불법적임 |
-1100 | 생성 가능한 객체의 수를 초과함 |
-1999 | 유효하지 않은 사용자 |
-2000 | 등록되지 않은 사용자, 등록 및 활성화 후 유효해짐 |
-2001 | 등록된 사용자, 활성화 후 다음 로그인 때 유효해짐 |
-2002 | 사용자가 프로젝트에 있음 |
-2003 | 운영자의 권한은 운영 대상보다 낮을 수 없음 |
-2004 | 매개변수가 누락됨, 관리자에게 문의하세요 |
-2005 | 운영 권한이 없음 |
-2006 | 데이터가 업데이트됨 |
-3000 | 라이센스 인증 실패 |
-3001 | 라이센스 인증 실패. TE 고객 서비스에 문의하여 문제를 해결하세요 |
-3004 | 프로젝트가 유효하지 않음 |
-3005 | MFA 검증 실패, 잘못되거나 만료된 MFA 검증 코드 |
-3006 | 현재 기업은 MFA 가상 장치에 대한 강제 로그인 검증을 활성화했습니다. 장치를 바인딩하세요 |
-3007 | 현재 사용자가 MFA 가상 장치를 바인딩했습니다. 바인딩 과정을 반복할 수 없습니다 |
-3008 | 현재 유저는 가상MFA 장치에 로그인 인증을 유효하게 설정했으나, MFA 인증 코드가 부족합니다. |
-3009 | 운영자는 지원되지 않습니다 |