Notionで提供されているAPIの使い方とどのようなことができるか気になっていますか?
NotionAPIのセットアップは比較的簡単にできて、Notionでの各種作業を自動化することができます。
この記事では初心者向けにNotionAPIの使い方とAPI一覧を解説します!
こんな人におすすめです。
- NotionAPIを使ってみたくて設定手順を手早く知りたい
- NotionAPIの使い方を知りたい
- NotionAPIでどのようなリクエストがあるのか知りたい
NotionAPIとは?
Notionが提供するAPIで、自分のnotionのデータベースやページ、ブロックに対する操作を自動化できます。
詳細はこちらをご覧ください
NotionAPIの使い方
Notion APIは、Notionのデータベースやページにアクセスし、操作するためのツールです。Notion APIを使用すると、自動化やカスタマイズが可能になり、Notionの機能を拡張することができます。以下に、Notion APIの基本的な使い方と概念について説明します。
APIを使えるようになるためにはトークンを発行する必要があります。
- step1開発者ポータルにアクセスする
まずは、Notionの開発者ポータルにアクセスします。
ページ右上のView my Integrationを押します。
- step2ログインする
ログイン画面が出てくるのでログインします。
- step3インテグレーションを作成する
インテグレーション一覧画面に入ったら、新しいインテグレーションを押します。
- step4インテグレーションの設定をする
インテグレーション名と導入するワークスペース名を入力して保存を押します。
作成されましたと表示されたらOKです。
インテグレーション設定を押します。
- step5トークンを発行する
内部インテグレーションシークレット(APIのアクセストークン)を表示して控えておきます。
- step6タイトル6
トークンが取得できたら、APIを使用できるようになっています。
以下のCurlコマンドで動作を確認してみましょう。
Authorizationヘッダーに取得したトークンを設定してリクエストを実行してみてください。
1curl https://api.notion.com/v1/users -H "Authorization: Bearer $取得したトークン”-H "Content-Type: application/json" -H "Notion-Version: 2022-06-28"
RESTAPI早見表
RESTAPIを一覧形式で表示しました。
リクエストPATHは【https://api.notion.com /+下記のPATH】になります。
内容 | REST | PATH | 補足 |
トークン作成 | POST | /v1/oauth/token | 3rdパーティツールとの連携に使用 |
ブロックの子を追加 | PATCH | /v1/blocks/ {block_id}/children | |
ブロックを取得する | GET | /v1/blocks/ {block_id} | |
ブロックの子を取得する | GET | /v1/blocks/ {block_id}/children | |
ブロックを更新する | PATCH | /v1/blocks/ {block_id} | |
ブロックを削除する | DELETE | /v1/blocks/ {block_id} | |
ページを作成する | POST | /v1/pages/ | |
ページを取得する | GET | /v1/pages/{page_id} | |
ページプロパティの項目を取得する | GET | /v1/pages/{page_id}/properties/{property_id} | |
ページのプロパティを更新する | PATCH | /v1/pages/{page_id} | ページの削除等 |
データベースを作成する | POST | /v1/databases | |
データベースをクエリする | POST | /v1/databases/{database_id}/query | |
データベースを取得する | GET | /v1/databases/{database_id} | |
データベースを更新する | PATCH | /v1/databases/{database_id} | |
全てのユーザーを一覧表示する | GET | /v1/users | |
ユーザーを取得する | GET | /v1/users/{user_id} | |
トークンのボットユーザーを取得する | GET | /v1/users/me | |
コメントを作成 | POST | /v1/comment | |
コメントを取得 | GET | /v1/comment | |
タイトルで検索 | POST | /v1/search |