오픈API란? OpenAPI(Application Program Interface)
- 누구나 사용할 수 있도록 공개된 API 로써 공공데이터 컨텐츠 및 데이터를 누구나 쉽게 활용하고 웹서비스 및 어플리케이션 개발을 지원하기 위하여 API를 외부에 공개한 것을 말합니다.
- 위키피디아에서는 API를 응용 프로그램에서 사용할 수 있는 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있도록 만든 인터페이스로 정의하고 있습니다.
- 이 API를 외부에서 사용할 수 있도록 공개한 것이 OPEN API이며, 웹서비스의 개방 지향적인 성격을 가지고 있습니다.
오픈API 사용방법
- 디비디비맵에서 제공하는 오픈API를 사용하기 위해서는 인증키를 발급 받으셔야 사용 가능합니다.
- 인증키 한 개로 도봉구의 모든 데이터를 활용 할 수 있습니다.
- 데이터 상세 정보의 콘텐츠 코드(cont_code)를 이용하여 해당 데이터를 활용 할 수 있습니다.
- 요청 방식 및 REQUEST FORMAT
| 요청방식 | URI방식 |
|---|---|
| 설명 | Open API는 RESTful 방식의 웹서비스 입니다. RESTful 웹서비스는 HTTP를 사용하는 웹기반 인터페이스로 GET 또는 POST 방식의 URI를 통해 서비스 되기에 파라미터의 값을 URL에 표기하여 페이지를 로딩합니다. |
| 요청 FORMAT | https://opendata.dobong.go.kr/opendata_api.asp?api_key={api_key}&cont_code={cont_code}&type={format_type} |
- 기본인자
| 변수명 | 타입 | 변수설명 | 값설명 |
|---|---|---|---|
| api_key | STRING(필수) |
"발급받은 api key (영문+숫자 20자리 난수형태) 예 ) 1nmGgX8HW4MX1rK1nmGg CmdLhS1jEQVDpfxNdkxd" |
· 로그인후 신청시 자동 발급 · 유효기간 발급후 24개월 - MYPAGE에서 최대 24개월 연장 가능 - MYPAGE에서 사용중지 가능 · 1개의 계정당 최대 5개의 API KEY 발급, · API KEY 당 1일 1만건 호출 가능 (0시 기준) |
| cont_code | INTEGER(필수) | 콘텐츠 코드 |
· 특정데이터를 호출하기 위한 인자 (콘텐츠 명세서 페이지에서 확인) |
| type | STRING(선택) | Response 파일 속성 |
xml : 기본값 csv excel json |
- API 반환 에러 코드 정의
| 분류 | statusCode | statusMsg |
|---|---|---|
| 정상 | 100 | 정상 |
| 서버오류 | 200 | DB 오류 입니다. |
| 210 | 서버 오류 입니다. | |
| API KEY 오류 | 300 | API Key 입력 오류 입니다. |
| 310 | API Key가 만료 되었습니다. | |
| 320 | API Key가 사용중지 상태 입니다. | |
| 330 | Open API 호출 일 허용량을 초과하였습니다. | |
| 입력 값 오류 | 400 | 필수 입력 값 오류 입니다. |
| 410 | 콘텐츠코드(cont_code) 값 입력 오류 입니다. | |
| 반환데이터 오류 | 500 | 데이터가 존재하지 않습니다. |
| 510 | 해당 데이터는 서비스 중지 상태로써 Open API로 제공하지 않습니다. |