NEIS 데이터 OpenAPI

개요

NEIS 데이터 OpenAPI는 나이스(NEIS)에서 제공하는 급식 데이터와 학사일정 데이터를 간단한 HTTP 요청을 통하여 서비스에 통합할 수 있도록 돕습니다. 해당 REST API를 호출하여 기본적인 급식 및 학사일정 데이터를 획득할 수 있습니다.

제공하는 API

NEIS 데이터 OpenAPI는 다음과 같은 두 가지 주요 API를 제공합니다:

인증

모든 API 요청은 HTTP 헤더에 API 키를 포함해야 합니다.

X-API-KEY: your-api-key-here

API 키는 UUID 형식이며, 만료되거나 유효하지 않은 키를 사용할 경우 401 Unauthorized 응답을 받게 됩니다.

권한 범위

NEIS_READ 권한 범위가 필요합니다.

공통 사항

날짜 형식

모든 날짜 파라미터는 ISO 8601 형식(YYYY-MM-DD)을 따릅니다.

예시: 2025-12-15

날짜 파라미터 사용 규칙

  • date: 특정 날짜의 데이터만 조회
  • fromDate와 toDate: 기간 범위 내의 데이터 조회
  • 파라미터를 생략하면 오늘 날짜 기준으로 조회

응답 형식

모든 성공 응답은 다음과 같은 공통 구조로 반환됩니다:

필드타입설명예시
statusStringHTTP 상태 메시지OK
codeIntHTTP 상태 코드200
messageString응답 메시지OK
dataArray데이터 목록 배열-

공통 오류 응답

상태 코드설명
401 UnauthorizedAPI 키가 유효하지 않거나 만료됨
403 Forbidden권한 범위 부족
429 Too Many Requests단위 시간에 너무 많은 요청량 발생
400 Bad Request잘못된 요청 파라미터

다음 단계