먼데이닷컴 FAQ

FAQ 목록

API Version 안내

API 버전 변경 안내

먼데이닷컴에서 제공하는 API 버전 및 지원 날짜 안내 문서입니다.
이전의 API 사용하시는 사용자들께서는 내용 확인 후 버전 및 버전에 맞는 쿼리로 변경하여 사용에 불편을 겪지 않으시길 바랍니다.

출시 일정

현재 먼데이 닷컴은 각 분기마다 새로운 버전이 출시됩니다. 버전 이름은 YYYY-MM 형식으로 출시 분기의 해당 연도 - 해당 분기의 첫 번째 달 형식으로 이름을 지정합니다. 예) 2023-01

버전	미리보기 가능	기본 버전	지원 종료
`2023-07`	2023년 4월 1일	2023년 7월 1일	2024년 1월 15일
`2023-10`	2023년 7월 1일	바로 아래 기본 API 버전*을 확인해주세요!	2024년 4월 1일
`2024-01`	2023년 10월 1일	2024년 1월 15일	2024년 7월 1일

🧾 기본 API 버전

2023-10 버전을 시작으로 수많은 주요 변경 사항이 포함되어 있습니다. 2023-07 은 기본 버전으로 2024년 1월 15일까지 유지될 예정입니다. 이것은 만일 요청 헤더에 API-Version을 명시하지 않으면, 자동으로 2023-07 버전을 반환 받을 것입니다.

여러분은 아래의 API 체인지로그, 개발자 커뮤니티, 릴리스 노트 에서 새로운 정보와 업데이트를 확인할 수 있습니다.

지원 중단 계획

지원 중단 일정은 최소 3개월 전에 공지됩니다. 이전 API를 대체하는 새 API 를 출시할 때마다 6개월 동안 이전의 기존 API를 지원합니다. 모든 지원 중단은 아래 리스트에 발표 및 문서화 됩니다.

❗❗ 아직 먼데이닷컴 버전 마이그레이션을 하지 못하셨나요?

아직 먼데이닷컴 마이그레이션을 하지 못한 사용자들을 위해 2024년 2월 15일까지 연장할 수 있습니다.

연장 범위에 따라 아래

사용자 범위

오른쪽 상단에 있는 프로필 사진을 클릭하세요.
Monday.labs 를 선택하세요 .
검색창에 API를 입력하세요 .
API One Month Version Extension 을 찾으세요 .
활성화 를 클릭합니다

계정 범위

계정 범위에서 연장은 계정에 포함된 모든 개인 토큰에 적용됩니다.

계정 범위 연장 양식

앱 범위

앱 개발자는 계정 토큰에 연장 여부에 관계 없이 앱에서 호출된 모든 API 에 대한 연장을 할 수 있습니다.
이 옵션은 마켓플레이스에 개발자에게 적합합니다.

앱 범위 연장 양식

어떻게 API 버전을 선택하나요?

API-Version 헤더를 사용하세요!

http 요청에 헤더의 설정한 API-Version따라 원하는 API 버전을 사용할 수 있습니다.

사용 원하는 버전의 이름 (날짜 형식 예: 2023-04)을 적어 요청하면 됩니다.

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
    'API-Version' : '2023-04'
   },
   body: JSON.stringify({
     'query' : 'query{version {kind value} }'
   })
  });

curl --location --request POST 'https://api.monday.com/v2' \
--header 'API-Version: 2023-04' \
--header 'Authorization: YOUR_API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"query { version { kind value } }"}'

모든 API 반환(response) 값은 API-Version 헤더를 포함하고 있으며, 요청하는 API 의 버전을 나타냅니다. 또한 쿼리를 요청하여 version 객체로 API 버전을 확인할 수 있습니다. 아래의 예시 요청의 version 객체를 참고하여 사용 가능한 모든 API 버전을 확인해 보세요.

query {
  version {
    kind
    value
  }
}

let query = 'query { version { kind value }}';

fetch ("https://api.monday.com/v2", {
  method: 'post',
  headers: {
    'Content-Type': 'application/json',
    'Authorization' : 'YOUR_API_KEY_HERE'
    'API-version' : '2023-04'
   },
   body: JSON.stringify({
     'query' : query
   })
  })
   .then(res => res.json())
   .then(res => console.log(JSON.stringify(res, null, 2)));

SDK 사용하기

먼데이닷컴은 Javascript SDK 를 사용하기 위한 두 가지 방법을 지원합니다.

특정 API 요청을 보낼 때, apiVersion 옵션을 통해 설정 할 수 있습니다.

const data = await monday.api('query { me { id } }', {
  apiVersion: '2023-10'
})

또는 setApiVersion을 기본 값으로 설정하여 사용 할 수 있습니다:

import mondaySdk from "monday-sdk-js";

const monday = mondaySdk();
monday.setApiVersion("2023-10");

API PlayGround

여러분은 API playgound 를 사용하여 다른 API 버전을 확인 할 수 있습니다.

1. API playground 에 들어갑니다.
2. 여러분의 API 토큰을 넣습니다.
3. 화면 중앙에 있는 시계 아이콘(되돌리기 아이콘)을 클릭합니다.
4. 원하는 API 버전을 선택하여 사용해 보세요!

잘 못된 버전의 API 를 요청하면 어떻게 되나요?

만일 여러분이 잘못된 형태의 요청을 보낼 시, InvalidVersionException을 받게 됩니다. (예: 2023-04 대신 2023을 보낼 시)
만일 여러분이 존재하지 않는 버전의 API를 요청할 시(예 2023-05), 현재 기본 버전의 API가 전송될 것입니다.

더 이상 지원되지 않는 API 버전으로 요청을 할 시 가장 최근에 지원되지 않는 버전을 받게 됩니다.

예를 들어, 2023년 8월 2023-01 요청 시, 해당 버전에 대한 지원은 2023년 7월 1일에 종료되었으므로 가장 최근에 지원 중단된 2023-04 버전을 받게 됩니다. 반대로, 아직 출시되지 않은 버전을 요청하면 최신 버전을 얻을 수 있습니다.

{
  "errors": [
    {
      "message": "Field 'new_field' doesn't exist on type 'Boards'",
      "locations": [
        {
          "line": 4,
          "column": 5
        }
      ],
      "path": [
        "query",
        "boards",
        "new_field"
      ],
      "extensions": {
        "code": "undefinedField",
        "typeName": "Boards",
        "fieldName": "new_field"
      }
    }
  ],
  "account_id": 1
}

버전 관리 예시

버전 관리는 API를 개선하는 방법이지만 어떤 버전을 언제 요청해야할지 이해하는 데 어려움을 가질 수 있습니다. 버전 관리를 더 잘 이용하는 데 도움이 되도록 아래와 같은 가상 시나리오를 만들었습니다!

1. 버전 2024-01에서 new_API라는 새로운 API 출시를 발표합니다. 2024-01이 미리보기 버전일 경우 API-Version 헤더에 2024-01을 전달하면 안정된 버전 출시 3개월 전에 new_API에 접근할 수 있습니다. API-Version 헤더를 포함하지 않으면 해당 필드가 존재하지 않는다는 오류가 발생합니다.

2. 2024-01 버전의 test 필드 출시를 발표합니다. 미리보기 버전에서는 최대 3개월 전에 미리 액세스할 수 있습니다. 요청할 때 API-Version 헤더를 포함하는 것을 잊었을 시 새로운 필드를 아직 사용할 수 없는 현재 버전을 자동으로 받게 됩니다. 새 필드에 액세스하려면 헤더에서 preview 를 전달하는 것을 잊지 마세요!

3. 버전 2024-01에서는 example 필드의 지원 중단을 발표합니다. 지원 중단된 각 버전은 3개월 동안 지원되므로 2024년 4월 1일까지 예시 필드에 액세스할 수 있습니다. 요청에서 2024-04를 전달하면 더 이상 예시 필드에 액세스할 수 없습니다.

4. 모든 요청의 API-Version 헤더에 2023-10이 포함되어 있다고 가정해 보겠습니다. 버전 2024-01에서 id 필드 유형을 Int에서 ID로 전환하는 주요 변경 사항을 발표합니다. 다른 요청을 했지만 헤더 업데이트를 잊어버린 2024년 7월로 빨리 가세요. 주요 변경 사항이 적용되는 버전 2024-01이 제공됩니다.

더 자세한 내용은 이 곳을 클릭하여 monday.com 공식 문서에서 확인하세요!

최근 업데이트 일자 : 2023. 12. 26

글로벌 No.1 협업툴, 먼데이닷컴

먼데이닷컴 국내 유일 플래티넘 파트너 IFIED

먼데이닷컴 FAQ

FAQ 목록

API Version 안내

먼데이닷컴 FAQ

FAQ 목록

API Version 안내

신청 완료

뉴스레터 구독신청 완료