본문 바로가기

OpenAPI

OpenAPI 이용 프로세스

  1. STEP01 홈페이지
    접속
  2. STEP02 OpenAPI
    인증키신청
  3. STEP03 OpenAPI
    검색/확인
  4. STEP04 OpenAPI 활용/
    애플리케이션 제작
  5. STEP05 애플리케이션
    등록

OpenAPI 이용방법

  1. 1. 인증키 발급
    • OpenAPI는 서울시립 미술아카이브(SeMA AA)에서 제공하는 예술/기관자료에 대한 검색 결과를 외부에 JSON 형태로 제공하는 방법입니다.
    • 서비스시스템에서 제공하는 OpenAPI를 이용하시려면 먼저 인증키 발급을 받아야 합니다.
  2. 2. 인증키 사용
    • OpenAPI는 하루에 최대 1,000건 요청할 수 있습니다. 1,000건이 넘는 경우 나누어서 호출해 주시기 바랍니다.
    • 담당자의 승인이 완료되면, 신청하신 이메일로 인증키를 발급해드립니다.
      발급받은 인증키를 이용하여 API 호출 결과를 확인하실 수 있습니다.

OpenAPI 상세 사용방법

기본요청주소(request url)

https://semaaa.seoul.go.kr/front/openapi.do?ApiKey=값

검색 조건 입력방법

https://semaaa.seoul.go.kr/front/openapi.do?ApiKey=값&컬럼명=값

요청 변수(request parameter)

좌, 우로 드래그 하세요

요청 변수

명칭, 컬럼명, 타입, 비고의 정보를 제공하는 표

명칭 컬럼명 타입 비고
APIKEY ApiKey String 승인 받은 Api키 입력
쿼리 q String 검색어 입력(예: 미술)
제목 title String 상세조회 제목 입력(예: 미술)
수집처 donor String 상세조회 수집처 입력(예: 서울시립)
생산자(생산기관) creator String 상세조회 생상자(생산기관) 입력 (예: 서울시립)
생산일자(시작일) dtstart String 생산일자 시작일부터 검색
* 형식 : yyyymmdd
생산일자(종료일) dtend String 생산일자 종료일까지 검색
* 형식 : yyyymmdd
페이지 page String 검색 결과 시작위치 지정. 기본값 페이지 번호: 1
출력수 display String 검색 결과 목록에 출력 건수 지정. 기본 값: 10