노션(Notion) API 사용법 데이터베이스 연동 테스트 하기

최근 많은 사람들한테 사랑받고 있는 협업툴로 노션이 있습니다. 생산성을 올려주고, 기능이 다양하고, 접근성이 쉽고, 진입장벽이 낮아서 더욱 사용자가 많은 것 같습니다. 이 노션을 150% 활용할 수 있는 방법으로 API 사용법을 소개해드립니다.

 

1. 노션 API를 사용하는 이유

이유는 각양각색 많겠지만 제가 꼽은 이유는 백엔드 개발자 없이 개인용 서버를 만들 수 있다는 점입니다.

개인 프로젝트를 진행할 때 DB가 필요한 작업이 있을 때 유용하게 사용 할 수 있습니다.

 

 

2. API 사용에 필요한 준비물

기본적인 노션 사용법(필수 지식)을 인지하고 있는 상태에서 이 글을 보셔야 이해가 쉬울 것으로 생각됩니다.

필수적으로 필요한 준비물이 2가지 있습니다

• Database ID
• Integration Token

이 두가지를 얻는 방법을 먼저 알아볼게요.

3. 노션 Database 생성

데이터베이스를 만들기 위해서는 페이지가 있어야 합니다.

노션 워크스페이스에서 페이지를 생성하고, 표를 클릭합니다.

 

현제 표에는 데이터베이스가 지정되어 있지 않기 때문에 데이터베이스를 선택해 주거나 생성해줘야 하는데

저희는 새로 테스트하는 것이기 때문에 생성해 줍니다.

 

 

데이터베이스가 생성되면 우측 [...]을 클릭합니다

 

 

 

[...] 을 클릭하면 보이는 레이아웃에서 보기 링크 복사를 클릭해 줍니다

그럽 클립보드에 값이 저장되게 됩니다.

 

https://www.notion.so/{id}/188aa9d50e044f958144312e59f794e?v={...}

위와 같은 형식으로 저장되는데, 우리가 필요한 값은 가운데 `/` 에서  `?v=` 사이에 있는 Database Id입니다.

이 값을 저장해 둡니다.

 

 

데이터베이스에 위에 예시처럼 속성을 추가해 줍니다.

일단 테스트를 위해 텍스트로만 생성해 줍니다

 

4. 통합 토큰 발급받기

데이터베이스 준비는 끝났고 이제 token을 발급받아보겠습니다.

https://www.notion.so/my-integrations <- 링크에 접속하셔서 새 API 통합 만들기를 클릭해 줍니다.

 

 

새 API 통합 만들기를 클릭하면 위 화면으로 진입하는데

이름, 지정할 로고, 연결할 워크스페이스를 선택하고 제출해줍니다.

나머지 설정들을 변경하고 싶은 대로 변경하시면 되고, 제출 후에도 수정 가능합니다.

 

생성하게 되면 위와 같이 통합 토큰이 발급되는데, 표시를 클릭하고 복사하면 됩니다.

여기까지 워크스페이스에 접근할 수 있는 토큰을 발급받았습니다.

 

 

5. 노션 API 테스트하기

준비물은 모두 준비가 됐고 이제 테스트를 해볼 차례입니다.

 

 

API 테스트를 위해 postman을 사용할 겁니다.

https://www.postman.com/

Postman API Platform | Sign Up for Free

 

위 링크 접속하셔서 여러분의 OS에 맞게 설치해 줍니다.

 

처음이신 분들은 google 계정을 이용해서 회원가입 후 My Workspace를 하나 만드시면 됩니다.

 

이미 설치되어 있는신분들은 바로 다음 단계로 넘어가서

 

 

postman 상단에 notion을 검색해 줍니다.

 

 

검색 결과 Notion's API Workspace가 보이는데, 저 workspace를 클릭하고

 

 

 

공개되어 있는 workspace를 내 워크스페이스에 포크(Fork) 합니다.

포크 하는 이유는 노션이 공개한 API Workspace를 우리 입맛대로 수정하기 위해...

 

 

 

포크를 완료화면 위 사진처럼 워크스페이스에 새로운 항목들이 보입니다.

여기서부터 테스트 시작인데,

위에서 저장해 뒀던 Database id, 통합 토큰이 필요합니다.

 

 

우선 가장 간단하게 database 리스트를 받아옵시다.

Query a database를 클릭해서 진입하고

위 사진처럼 path > id에 저장해 뒀던 database id를 입력해 줍니다.

 

다음으로 API를 사용하기 위해 권한이 필요하기 때문에 Authorization(인증)을 설정해줄 겁니다.

여기서 이전에 저장해 뒀던 통합 토큰을 사용합니다

Inherit auth from parent를 클릭하시고 나오는 dropdown 박스에서 Beare Token을 클릭해 줍니다.

 

 

Bearer Token을 클릭하면 Token을 입력할 수 있는 창이 나오는데 여기에 아까 저장해 둔 secret_%@^$%@^ 를 복사&붙여넣기 해줍니다

 

 

 

다음으로 노션 API의 버전을 입력해줘야 하는데 NOTION_VERSION에 현재 날짜 기준으로는 가장 최근 버전인 2022-06-28을 넣어줍니다.

 

 

 

여기까지 설정을 잘 따라오셨다면 준비는 끝났습니다. 바로 Send 버튼을 눌러봅니다!!!

 

 

짜잔~

이렇게 200 OK와 함께  결과가 넘어옵니다.

 

 

 

 

https://api.notion.com/v1/databases/:id/query api의 Response에 JSON데이터 중첩된 게 보이시나요..

끔찍한 뎁스를 보여주는데도 단기간에 백엔드개발자 없이 직접 DB를 만들 수 있기 때문에 너무나도 유용합니다.

 

지금까지 노션 API 사용법을 알아봤습니다. 너무 간단해서 글 하나로 정리가 되네요!

각자 개발하는 플랫폼에 맞게 DTO를 잘 정리해서 작성하면 편하게 사용 가능할 것 같아요.