API 이용 안내
서비스 개요
Dataware API는 누구나 계정만 만들면 바로 호출하는 공개형 API가 아닙니다.
데이터셋을 먼저 확인하고, 사용 목적을 제출한 뒤, 운영 심사를 거쳐 승인된 계정만 API 키를 발급받아 이용하는 운영형 서비스입니다.
이용 흐름
- 로그인 후 필요한 dataset을 먼저 확인합니다.
/application에서 API 사용 신청서를 제출합니다.- 운영 검토를 거쳐 승인 여부가 결정됩니다.
- 승인된 계정은
/api-keys에서 API 키를 발급합니다. /usage에서 사용량과 호출 현황을 확인합니다.
신청 상태와 계정 상태는 별도로 관리됩니다. 신청이 승인되어도 계정 상태가 유효하지 않으면 실제 키 발급과 호출은 제한될 수 있습니다.
신청 전에 준비할 정보
- 담당자 이름, 이메일, 전화번호
- 회사명, 부서, 직책
- 어떤 서비스나 업무에 데이터를 연결할 예정인지에 대한 설명
- 실제로 사용할 dataset 범위
전체 데이터를 한 번에 요청하기보다, 먼저 /datasets에서 필요한 카탈로그를 확인하고 필요한 범위 기준으로 신청하는 방식을 권장합니다.
심사와 승인 기준
신청은 아래 상태로 관리됩니다.
| 상태 | 의미 |
|---|---|
pending | 접수 후 대기 |
under_review | 운영 검토 중 |
needs_more_info | 추가 정보 필요 |
approved | 승인 완료 |
rejected | 승인되지 않음 |
운영 검토에서는 아래 내용을 함께 봅니다.
- 어떤 dataset을 사용할 예정인지
- 외부 서비스 제공용인지, 내부 분석용인지
- 운영 중 추가 권한 조정이 필요한지
승인 후 사용할 기능
승인된 계정은 아래 화면을 사용합니다.
/dashboard계정 상태와 다음 행동을 확인하는 시작 화면/api-keysAPI 키 발급, 재발급, 폐기/usage최근 호출량과 기간별 사용량 확인
API 키 원문은 발급 직후 한 번만 표시되므로 안전한 위치에 즉시 보관해야 합니다.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://dataware.actibooky.com/v1/datasets
자주 묻는 흐름
- 로그인만으로는 API를 바로 사용할 수 없습니다.
- 신청 후에는
/application/status에서 검토 진행 상황을 확인할 수 있습니다. - 승인된 계정만 API 키를 발급할 수 있습니다.
- 추가 dataset 이용이 필요하면 기존 신청 이력과 계정 상태를 기준으로 다시 검토될 수 있습니다.