Notion API 가이드 - Notion API 시작하기.

2021. 6. 6. 14:00

Notion API Developer - Beta 한글 번역

0. 앞선 글.

Notion에서 드디어 API 서비스를 시작했습니다. 오래 기다린 기능인만큼 바로 사용해보고 싶은데 아직 한글 가이드가 없어 공식 가이드를 읽으며 참고할만한 내용을 포스팅합니다.

1. 시작하기.

Notion API를 사용해 처음으로 API 요청을 만드는 방법에 대해 알아보겠습니다.

Notion API를 처음 사용한다면 잘 찾아오셨습니다. 이 가이드에서는 다음과 같은 방법을 알아봅니다.

* Notion 워크스페이스에서 통합(Integration)을 생성합니다.

* Notion에서 새 데이터베이스를 만들고 통합 권한을 부여해 액세스 합니다.

* 코드를 사용해 데이터베이스에 페이지를 추가합니다.

2. 시작하기 전에.

시작하기 전에 필요한 몇 가지 사항이 있습니다.

* 관리자 유저로 Notion 워크스페이스에 로그인합니다.

* CURL 커맨드가 설치된 터미널 프로그램.

3. 신규 통합 만들기.

브라우저를 새로 열어 Notion 통합 페이지를 엽니다. "새 통합" 버튼을 사용해 신규 통합을 생성합니다. 통합 이름을 지정하세요. 이 예시에서는 "Vacation Planner"로 정했습니다. 제출을 완료해 통합을 생성합니다.

https://developers.notion.com/docs/getting-started

시크릿 아래에서 내부용 통합 토큰을 찾을 수 있습니다. 이 토큰을 표시하도록 하고 복사해두세요. 텍스트 에디터와 같은 나중에 쉽게 찾을 수 있는 곳에 붙여 넣어 둡시다.

4. 통합을 사용해 데이터베이스 공유.

API로 구축된 통합은 사용자에 공유 권한과 유사한 권한 시스템을 따릅니다. 여기에는 중요한 차이점이 있습니다. 통합은 처음엔 워크스페이스의 페이지나 데이터베이스에 액세스 할 수 없습니다. API를 통해 해당 페이지에 액세스 하려면 사용자가 특정 페이지를 통합에 공유해야 합니다. 이런 방식으로 Notion에서 사용자와 팀의 정보를 안전하게 보호할 수 있습니다.

워크스페이스의 새 페이지 또는 기존 페이지에서 시작해봅시다. /표 혹은 /table을 입력하여 새 데이터베이스를 추가합니다. 제목을 정해줍니다. 이 예시에서는 "Weekend getaway destinations"라고 정했습니다. 이제 공유 버튼을 클릭해 실렉터에서 통합을 찾아 선택한 뒤 초대를 클릭합니다.

이제 통합에 새 데이터베이스를 읽고 쓰고 편집할 수 있는 권한이 부여되었습니다. 통합이 워크스페이스에 추가되면 모든 구성원과 통합이 같이 페이지 및 데이터베이스를 공유할 수 있습니다. 이 단계에서는 관리자 권한이 요구되지 않습니다.

계속하기 전에 방금 만든 데이터베이스의 ID를 알아보도록 합시다.

Notion 데스크톱 앱을 사용하는 경우 공유 버튼을 다시 한번 클릭해 링크 복사를 선택합니다. 브라우저에 이 URL을 붙여 넣고 확인하세요. 이 URL에서 데이터베이스 ID는 워크스페이스 이름 슬래시(/) 뒤부터 물음표(?) 앞까지입니다. 데이터베이스 ID는 문자와 숫자를 포함하는 32자입니다. 이 ID를 복사해 나중에 쉽게 찾을 수 있는 곳에 저장해 두세요.

https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
|-------------------- Database ID ------------------|

5. 데이터베이스에 아이템 추가하기.

Notion 데이터베이스에서 각각의 아이템은 자식 페이지입니다. 부모를 데이터베이스로 설정함으로써 새 페이지를 생성해 데이터베이스에 아이템을 추가할 수 있습니다. 새 아이템을 추가하기 위해 페이지 생성 엔드포인트에 HTTP 요청을 보내봅시다.

터미널 프로그램을 열고 다음 커맨드를 입력하세요. Authorization와 database_id의 값은 앞서 생성한 적절한 값으로 변경되어야 합니다. 줄 끝에 보이는 문자(\) 뒤에 공백이 없어야 함을 주의하세요.

curl -X POST https://api.notion.com/v1/pages \
  -H "Authorization: Bearer MY_NOTION_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Notion-Version: 2021-05-13" \
  --data '{
    "parent": { "database_id": "DATABASE_ID" },
    "properties": {
      "Name": {
        "title": [
          {
            "text": {
              "content": "Yurts in Big Sur, California"
            }
          }
        ]
      }
    }
  }'

커맨드를 실행하고 Notion으로 이동해 새 항목이 데이터베이스에 추가되었는지 확인하세요.

이제 Notion API를 사용해 데이터베이스에 새 항목을 추가했습니다. 커맨드와 함께 보낸 HTTP 요청에 대해 좀 더 자세히 살펴보겠습니다.

* Notion API는 REST API 규칙을 따릅니다.

* 토큰은 Authorization 헤더에 포함되며 요청의 출처를 식별합니다.

* Notion API의 각 엔드포인트는 파라미터를 사용해 호출할 수 있습니다. 엔드포인트의 참고 페이지에는 이러한 파라미터에 대해 설명되어 있습니다. 이 예시에서 parent와 properties는 모두 본문에 명시되어 있습니다. 데이터베이스 작업 가이드에는 다른 엔드포인트를 사용하는 방법에 대해 설명되어 있습니다,

6. 마무리

방금 배운 내용을 사용하면 다른 서비스와 시스템을 연결해 새로운 정보를 Notion에 보내거나 업데이트 해 여러분의 팀이 정보를 확인하고 조치를 취할 수 있도록 합니다.

이 가이드에서는 CURL 명령어를 통해 Notion API에 HTTP 요청을 보내는 방법을 사용하였습니다. 일반적으로 통합은 프로그래밍 언어를 사용하여 코드로 작성될 것입니다. 거의 모든 프로그래밍 언어를 사용할 수 있지만 통합을 사용한 코드를 실행하는데 가장 쉽고 빠른 방법을 찾고 있다면 이 예제를 사용해 보세요. 숙련된 프로그래머들에게도 이 예제는 훌륭한 시작점이 될 것입니다.

* 이 글은 Notion API Develpers - Beta: Getting started를 번역한 글입니다.

Getting started

Learn how to make your first API requests using the Notion API

developers.notion.com

저작자표시

'Trunk' 카테고리의 다른 글

씽크웨이 토체티 BW D&T 콜라보 K320w 구매 후기 (0)	2021.07.12
Notion API 가이드 - 페이지 콘텐츠 작업. (1)	2021.06.06
Notion API 가이드 - 데이터베이스 작업. (0)	2021.06.06
쿠키런 킹덤 쿠폰 모음 (0)	2021.02.14
[Synology] Mac Finder에서 Synology 접속하기 (1)	2021.01.30

Simple is Beautiful.