manuallatest제품 매뉴얼 / Open API
Open API
이 문서에서 설명하는 내용은 AE의 고급 기능으로, 기술적인 세부 사항이 많아 관련 기능을 사용해 본 경험이 있는 사용자를 대상으로 합니다. 문서 내용에 대해 궁금한 점이 있으면 담당 데이터 컨설턴트에게 문의하여 일대일 지원을 받으십시오.
AE는 강력한 UI 분석 화면 외에도 완전한 API를 제공합니다.
- 모델 조회 API: 모델 조회 인터페이스를 통해 데이터를 가져옵니다.
- 데이터 커스텀 조회 API: SQL을 통해 데이터를 가져옵니다.
- 유저 코호트 및 태그 API: 주로 유저 코호트와 태그를 설정하는 데 사용합니다.
- 차원 테이블 API: 주로 차원 테이블을 설정하는 데 사용합니다.
- 데이터 테이블 API: 주로 데이터 테이블을 조작하는 데 사용합니다.
- SQL 문 생성 API: 주로 SQL 문을 생성하는 데 사용합니다.
- 메타데이터 관리 API: 주로 메타데이터를 관리하는 데 사용합니다.
- 대시보드 리포트 관리 API: 주로 대시보드와 리포트 데이터를 관리하는 데 사용합니다.
- 유저 관리 API: 주로 유저 데이터를 관리하는 데 사용합니다.
- 프로젝트 관리 API: 주로 프로젝트 데이터를 관리하는 데 사용합니다.
- 지표 조회 API: 지표 목록을 조회하거나 지표 조회 인터페이스를 통해 데이터를 가져옵니다.
호출 방법
쿼리 키 생성
Open API를 사용하려면 먼저 프로젝트 키를 생성해야 합니다. 프로젝트 키는 두 종류가 있으며, 키를 생성하는 명령은 ta-tool에서 실행해야 합니다.
아무 AE 서버에나 로그인하여 su - ta 명령을 실행해 ta 사용자로 전환한 후 ta-tool을 실행합니다.
root 키 생성
ta-tool generate_root_secret
- 이 키는 모든 프로젝트에 사용할 수 있습니다.
단일 프로젝트 키 생성
ta-tool generate_api_secret -appid TEST-APPID
- 전달하는 매개변수는 해당 프로젝트의 APPID이며, 이 키는 해당 프로젝트에만 사용할 수 있습니다.
- 특수한 경우: 단일 프로젝트 키로 데이터 커스텀 조회 API를 호출하면 기본적으로 모든 프로젝트의 데이터를 조회할 수 있습니다. 제한이 필요하면 ThinkingAI 담당자에게 문의하십시오.
주의: 같은 프로젝트 키나 root 키의 생성을 반복해서 실행하면 새 키가 생성되고 이전 키는 무효화됩니다.
API 호출 규칙
API는 HTTP GET 또는 POST 메서드로 호출 요청을 제출하며, 호출 URL은 다음과 같습니다.
여기서 $HOST는 프라이빗 배포 클러스터 주소로 일반적으로 ta1이며, 기본적으로 내부망 호출만 지원합니다. $API_PATH는 구체적인 API 경로를 나타내며, 예를 들면 open/event-analyze입니다. $API_SECRET은 키입니다.
API는 GET 메서드 또는 POST 메서드로 호출 요청을 제출합니다. POST 요청 본문은 JSON 형식이며, 구체적인 매개변수 설정은 관련 문서를 참고하십시오.
응답 본문은 JSON 형식이며, 기본 구조는 다음과 같습니다.
{
"return_code": 0,
"return_message": "success",
"data": {...},
"stackMessage": "",
"showStackMessage": false
}
| 필드 | 설명 |
|---|---|
| return_code | 반환 코드. 0은 성공, 그 외는 실패를 나타냄(자세한 설명은 아래 표 참고) |
| return_message | 반환 메시지 |
| data | 호출 결과 데이터 |
| stackMessage | 실패 시 예외 스택 |
| showStackMessage | AE 제품 프런트엔드에서 사용(OpenAPI 호출 시 이 필드는 무시 가능). 예외 스택 복사 버튼을 표시할지 여부를 나타냄 |
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 | license 검증에 실패했습니다. ThinkingAI 고객 지원 담당자에게 문의하여 해결하십시오 |
| -3004 | 유효하지 않은 프로젝트 |
| -3005 | MFA 인증 실패. 잘못되었거나 만료된 MFA 인증 코드입니다 |
| -3006 | 현재 기업에서 MFA 가상 디바이스 로그인 인증을 의무화했습니다. 연동하십시오 |
| -3007 | 현재 유저는 이미 MFA 가상 디바이스를 연동했으므로 중복으로 연동할 수 없습니다 |
| -3008 | 현재 유저는 MFA 가상 디바이스 로그인 인증을 활성화했으나 MFA 인증 코드가 없습니다 |
| -3009 | 지원되지 않는 작업 |
이 문서가 도움이 되었나요?

