Notion에서 private API를 등록하는 방법은 많은 분들이 소개하고 계시지만, public API를 등록하기 위해서 필요한 작업과 과정에 대해서는 소개하는 글이 적은 것 같습니다. 그래서 제가 겪었던 public API 등록 과정에 대해 간략하게 소개 드리고자 합니다.

💡 이 과정에서는 다음과 같은 것들을 사용합니다

Notion

AWS Route53

AWS lambda

AWS API gateway

python

notion client(python notion API)

1. 커스텀 API 만들기

이 단계에서는 커스텀 퍼블릭 API 만들기를 위해 필요한 과정을 입력합니다. 미리 준비해야 할 것은 세 가지입니다.

💡 준비사항

홈페이지

개인정보 처리방침

이용약관

반드시 커스텀 도메인일 필요는 없습니다. 그저 웹 상에서 접근 가능한 주소면 됩니다. 즉, 노션 페이지를 게시해도 큰 문제는 없습니다.

노션 화면에서 설정 을 클릭합니다

설정 화면에서 연결 탭을 클릭합니다

API 연결 개발 또는 관리 를 클릭합니다

API 통합 화면에서 새 API 통합 버튼을 클릭합니다

필요한 정보를 입력

API 통합의 이름, 관련 워크스페이스, 유형, 회사 이름, 웹사이트, 태그라인 등의 기초 정보를 입력합니다. 태그라인의 경우, API를 설명하는 간략한 문장입니다. 적절한 문장을 입력하세요.

개인정보 보호정책 URL, 이용약관 URL, 이메일을 입력

개인정보 보호정책 URL, 이용약관 URL, 이메일과 로고를 입력합니다.

로고 아이콘과 리다이렉션 URI를 입력

프라이빗 API와 다르게 퍼블릭 API는 사용자별로 생성된 API 키를 기반으로 요청을 수행합니다. 따라서, 등록된 사용자의 API 키를 저장할 리다이렉션 URI가 필요합니다. 궁극적으로는 웹 상의 API 주소가 되어야 하지만, 개발 단계에서는 localhost:8080 등을 입력하는 것도 가능합니다.

API 통합 생성이 완료된 모습

API 통합 생성이 완료되었습니다. API 통합 설정 구성으로 이동해서 확인해보겠습니다.

OAuth 클라이언트 ID와 OAuth 클라인트 시크릿, 인증 URL

API가 등록되었기 때문에 OAuth 클라이언트 ID와 OAuth 클라이언트 시크릿, 인증 URL을 확인할 수 있습니다. 노출되지 않도록 주의하세요.

여기까지 퍼블릭 API의 등록 과정을 소개했습니다. 다음 글에서는 등록한 API를 이용해 실제로 데이터를 조작하는 것까지 진행해 보겠습니다.