오픈 API

1. 개요

민관협력 지원 플랫폼에서는 위기대응 서비스 개발에 필요한 각종 API(데이터 포함)를 무료로 제공하고 있습니다.

특히, 가장 중요한 데이터의 경우 플랫폼에서 사용하면 각 데이터 제공기관의 회원가입 및 키 생성이 필요하지 않습니다. 필요한 데이터를 선택하고 손쉬운 신청을 통해 원스텝으로 사용할 수 있습니다.

위기대응 데이터 제공 플로우

2. 데이터 API 신청 및 사용

2.1. 데이터 검색

위기대응 서비스 개발에 필요한 각종 데이터를 제공합니다. 관계 부처, 공공기관에서 제공하는 데이터 및 민간에서 제공하는 데이터들을 다수 제공합니다.

1. 데이터는 사회현안, 제공기관, 파일포맷의 3가지 카테고리로 제공됩니다. 각 카테고리별 검색조건은 중복으로 선택 가능하며, 각 조건은 OR로 검색됩니다.

2. 키워드란은 검색어와 동일합니다. 카테고리 조건을 만족하는 검색 결과 중에 키워드를 포함하는 결과만 출력합니다.

3. 기본으로 결과를 10개씩 출력하지만 더욱 많은 결과를 한번에 보고 싶다면 결과 표시 개수를 더큰 숫자로 설정 하시길 바랍니다.

2.2. 데이터 신청

원하는 데이터를 선택하면 해당 데이터의 상세 정보 페이지로 이동합니다. 데이터 API의 구조와 랜딩페이지를 확인하고 하단의 신청하기를 클릭합니다.

1. 랜딩페이지는 해당 데이터를 제공하는 원본 페이지입니다. 페이지에 따라 예제 코드를 제공하는 등 상세한 정보들을 제공하니 데이터사용에 어려움이 있으면 참고바랍니다.

2. 데이터를 실제로 사용하기 위해선 신청하기 버튼을 클릭합니다. 신청 즉시 데이터 사용이 가능합니다. 사용방법은 2.3. 데이터수신을 참고바랍니다.

2.3. 데이터 수신

플랫폼은 신청된 데이터를 기본적인 API형태로 제공하며, 최종적으로 제공되는 접속 URL에 파라미터를 변경하여 원하는 데이터를 수신할 수 있습니다.

콘솔 페이지에서 'My Data > 사용 신청 데이터 관리' 경로로 이동하면 신청한 데이터의 목록을 확인할 수 있습니다. 필요한 데이터의 접속 URL을 통하여 데이터를 반환 받습니다. 접속 URL의 데이터 상세페이지를 확인하고 안내에 따라 파라미터를 변경하여 사용합니다.

1. 콘솔 페이지에서 'My Data > 사용 신청 데이터 관리' 경로로 이동하면 신청한 데이터의 목록을 확인할 수 있습니다.

2. 데이터의 접속 URL을 통하여 데이터를 반환 받습니다. 접속 URL의 데이터 상세페이지를 확인하고 안내에 따라 파라미터를 변경하여 사용합니다.

예를 들어 건강보험심사평가원_의료기관별 감염병 및 중증환자 치료시설 현황의 데이터를 불러오고자 한다면 플랫폼 콘솔의 사용 신청데이터관리 페이지로 이동 후 접속 URL을 복사합니다. 그리고 파라미터를 필요에 따라 수정하여 요청합니다.

'http://223.130.129.189:9191/c40f12ef-e823-4486-aedf-f416be0d7d74/page={페이지 수}&perPage={한 페이지 표시 수}' 의 URL 에서 {페이지 수}와 {한 페이지 표시 수}에 원하는 파라미터를 입력하여 사용합니다.

Parameters

name	Description
page integer($int64)(query)	page index Default value : 1
perPage integer($int64)(query)	page size Default value : 10
returnType string(query)	응답의 데이터 타입을 선택할 수 있습니다. (기본값: JSON) XML형태의 응답결과를 얻기 위해서는 XML 값으로 설정

{
    "currentCount": 10,
    "data": [
        {
            "격리병실 병상수": 33,
            "성인중환자실 병상수": 40,
            "소아중환자실 병상수": 0,
            "시군구명": "동작구",
            "시도명": "서울특별시",
            "신생아 중환자실 병상수": 15,
            "요양기관명": "중앙대학교병원",
            "요양기관종별": "상급종합병원",
            "주소": "서울특별시 동작구 흑석로 102 (흑석동)",
            "중환자실 병상수 소계": 55,
            "표시과목": "해당사항없음"
        },
    ],
    "matchCount": 41497,
    "page": 1,
    "perPage": 10,
    "totalCount": 41497
}

3. 오픈 API 사용

위기대응 프로젝트에 도움이 되는 오픈 API들을 소개하는 페이지입니다.

플랫폼에서 제공하는 클라우드 자원(Naver, KT, NHN) 사용 시 각 콘솔을 통하여 API를 사용합니다. 자유롭게 사용가능 하나 월간 클라우드 사용량 제한이 있음을 유의하여 사용하시길 바랍니다.

이외의 플랫폼에서 제공하지 않는 카카오 클라우드 등에서 제공하는 API는 개인 계정을 생성한 후 인증키를 받아 사용합니다.

무료로 제공되는 오픈 API 위주로 소개 하고 있지만 사용함에 따라 비용이 발생 할 수도 있기 때문에 사용 전 반드시 가격정책을 확인하시길 바랍니다. 플랫폼 계정이 아닌 개인 계정에 발생하는 비용은 플랫폼에서 부담하지 않습니다.

4. 오픈소스 소프트웨어 사용

오픈 API의 형태는 아니지만 플랫폼에선 우수한 위기대응 소프트웨어들의 소스를 제공하고 있습니다. 해당 소스들을 참고하여 위기대응 아이디어를 확장하고 프로젝트를 더욱 고도화 할 수 있습니다.

각 소프트웨어의 소스는 Github으로 제공됩니다. 플랫폼의 Open S/W 페이지에서 필요한 소프트웨어를 선택하면 대응하는 Github으로 이동합니다.

오픈소스 소프트웨어 사용 시 발생하는 문제에 대해선 해당 소프트웨어 개발자에게 개별 연락 하시길 바랍니다.