v0.2.3-beta
ログイン 登録

brainful APIライブラリ

概要

The brainful API あなたのアプリケーションとのシームレスな統合を可能にします brainful's 強力な コンテンツ管理システム. 自動化ツールの構築やお気に入りのアプリとの統合において, 私たちの RESTFUL API あなたのコンテンツとやり取りするシンプルで安全な方法を提供します.

主要機能

安全な認証

HTTPS暗号化を伴うトークンベース認証

RESTful設計

標準HTTPメソッドとJSONレスポンス

位置情報サポート

組み込み位置情報機能

レート制限

パフォーマンスメトリクスの取得に失敗しました

使用例

個人用自動化

  • お気に入りのアプリからノートを自動保存
  • 位置ベースのコンテンツトリガーを作成
  • 接続 IFTTT/Zapier ワークフロー

統合ソリューション

  • カスタム統合と拡張機能を構築
  • 自動化されたコンテンツワークフローを作成
  • 開発 コンテンツ管理システム

リファインメント

レート制限

60 ユーザーあたり毎分のリクエスト数

はじめましょう

1

APIトークンを取得

あなたの brainful オプションページ を訪問してAPIトークンを生成してください.

2

統合方法を選択してください

以下のサンプルコードから選択してください cURL, JavaScript, または Python で簡単に始めることができます.

3

最初のリクエストを送信

以下のインタラクティブな例を試して統合をテストしてください.

認証

すべてのAPIリクエストにはAuthorizationヘッダーにAPIトークンが必要です。トークンは brainful オプションページ. APIはtokenとbearer tokenの両方の形式をサポートしています.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

ブロックを作成する

POSThttps://brainful.dev/blocks/add

リクエストパラメーター

すべてのパラメーターはリクエストボディで送信されます JSON.

パラメータータイプ必須説明
文字列文字列はい追加されるコンテンツ (1-5000 文字)
parent_luid文字列いいえluid 親ブロックの (オプション)
latitude浮動小数点数いいえ緯度 (-90° へ 90°)
longitude浮動小数点数いいえ経度 (-180° へ 180°)
agent文字列いいえAgent identifier (max 50 chars)
team_space文字列いいえTeam space slug to add the block to (only for organization members)

Generated Request

レスポンス例

{
                    "luid": "abc123",
                    "slug": "My New Block",
                    "type": "thought",
                    "pinned": false,
                    "entities": [],
                    "created_timestamp": "2024-01-01T00:00:00Z",
                    "last_edited": "2024-01-01T00:00:00Z",
                    "experience": 5,
                    "remaining_daily_quota": 97
                  }

レスポンスフィールド

luid

タイプ: 文字列

作成されたコンテンツの一意識別子

slug

タイプ: 文字列

URL-friendly version of the content

words

タイプ: 整数

Number of words in the content

remaining_daily_quota

タイプ: 整数

Remaining content creation quota for today

レスポンスコード

201作成済み (成功)
400無効なリクエストボディ (無効な文字列)
401未許可 (無効なトークン)
403Forbidden (plan not sufficient)
422Invalid location coordinates

ブロックに追加する

POSThttps://brainful.dev/blocks/append

リクエストパラメーター

すべてのパラメーターはリクエストボディで送信されます JSON.

パラメータータイプ必須説明
identifier文字列はい 追加したいブロックを説明してください (luid または slug)
文字列文字列はい追加されるコンテンツ (1-5000 文字)

Generated Request

レスポンス例

{
  "details": "Text appended to block successfully.",
  "luid": "abc123",
  "slug": "my-example-block"
}

レスポンスフィールド

luid

タイプ: 文字列

作成されたコンテンツの一意識別子

slug

タイプ: 文字列

URL-friendly version of the content

words

タイプ: 整数

Number of words in the content

remaining_daily_quota

タイプ: 整数

Remaining content creation quota for today

レスポンスコード

201作成済み (成功)
400無効なリクエストボディ (無効な文字列)
401未許可 (無効なトークン)
403Forbidden (plan not sufficient)

ブロックを取得する

GEThttps://brainful.dev/blocks/get/{luid}

リクエストパラメーター

URL Parameters

パラメータータイプ必須説明
luid文字列はい取得するブロックの一意識別子

リクエストボディ

パラメータータイプ必須説明
latitude浮動小数点数いいえ緯度 (-90° へ 90°)
longitude浮動小数点数いいえ経度 (-180° へ 180°)
agent文字列いいえ エージェント識別子 (最大 50 文字)

Generated Request

レスポンス例

{
  "creator": "johnnyappleseed",
  "luid": "abc123",
  "slug": "My New Block",
  "type": "thought",
  "html": "

My New Block

", "blocks": [], "entities": [], "flagged": false, "pinned": false, "archived": false, "trashed": false, "public": false, "created_timestamp": "2025-01-28 18:01", "last_edited": "2025-01-28 18:01", "words": 3, "bytes": 45, "hits": 0 }

レスポンスフィールド

creator

タイプ: 文字列

Username of the content creator

luid

タイプ: 文字列

ブロックの一意識別子

type

タイプ: 文字列

コンテンツタイプ (例:, "thought")

html

タイプ: 文字列

HTML ブロックのコンテンツ

created_timestamp

タイプ: 文字列

Creation date and time

hits

タイプ: 整数

Number of views

レスポンスコード

200成功 (ブロックが見つかりません)
401未許可 (無効なトークン)
403Forbidden (plan not sufficient)
404見つかりません (ブロックが見つかりません)

インスピレーションを感じる?

brainful User APIで構築された公式統合の一部をご覧ください こちら!