v0.3.7-beta

от

Intelligence Unleashed

войти регистрация

продукт community журнал обновления

войти регистрация

brainful библиотека API

Быстрая навигация

обзор начало работы аутентификация создать блок добавить к блоку получить блок вдохновиться

обзор

О brainful API обеспечивает беспрепятственную интеграцию между вашими приложениями и brainful's мощной системой управления контентом. Независимо от того, создаёте ли вы инструменты автоматизации или интегрируетесь с вашими любимыми приложениями, наш RESTFUL API обеспечивает простой и безопасный способ взаимодействия с вашим контентомобеспечивает простой и безопасный способ взаимодействия с вашим контентомпредоставляет простой и безопасный способ взаимодействия с вашим контентом.

Ключевые возможности

Безопасная аутентификация

Аутентификация на основе токенов с шифрованием HTTPS

RESTful дизайн

Стандартные HTTP-методы с JSON-ответами

Поддержка местоположения

Встроенные возможности геолокации

Ограничение частоты запросов

Оптимизировано для надёжной производительности

Случаи использования

Личная автоматизация

Автоматическое сохранение заметок из ваших любимых приложений
Создавайте триггеры контента на основе местоположения
Подключайтесь к IFTTT/Zapier рабочим процессам

Решения для интеграции

Создавайте пользовательские интеграции и расширения
Создавайте автоматизированные рабочие процессы контента
Разрабатывайте системы управления контентом

Требования

Ограничения частоты запросов

60 запросов в минуту на пользователя

Начало работы

Получите ваш API-токен

Посетите ваши brainful страницу настроек чтобы сгенерировать ваш API-токен.

Выберите ваш метод интеграции

Выберите из нашего примера кода в cURL, JavaScript, или Python чтобы быстро начать.

Сделайте ваш первый запрос

Попробуйте интерактивные примеры ниже, чтобы протестировать вашу интеграциюпопробуйте интерактивные примеры ниже, чтобы протестировать вашу интеграциюпопробуйте интерактивные примеры ниже для тестирования вашей интеграции.

аутентификация

All API requests require your API token in the Authorization header. Get your token from the brainful страницу настроек. API поддерживает как токены, так и форматы bearer-токенов.

Ваш API-токен:

Authorization: Token YOUR_API_TOKEN

Authorization: Bearer YOUR_API_TOKEN

создать блок

POSThttps://brainful.one/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)

Строковое содержание:Родительский блок luid: широта (градусов, -90° до 90°): долгота (градусов, -180° до 180°): агент (до 255 симв.):Слаг командного пространства:

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.one/blocks/append

Параметры запроса

Все параметры отправляются в теле запроса как JSON.

Параметр	Тип	Обязательно	Описание
identifier	строка	Да	Идентификатор блока для добавления (luid или slug)
строка	строка	Да	Содержание для добавления (1-5000 символов)

Идентификатор блока (LUID или slug): Строковое содержание:

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.one/blocks/get/{luid}

Параметры запроса

URL Parameters

Параметр	Тип	Обязательно	Описание
luid	строка	Да	Уникальный идентификатор блока для получения

Тело запроса

Параметр	Тип	Обязательно	Описание
latitude	число с плавающей точкой	Нет	широта (-90° до 90°)
longitude	число с плавающей точкой	Нет	долгота (-180° до 180°)
agent	строка	Нет	Идентификатор агента (максимальный 50 симв.)

блок LUID (6 симв.): широта (градусов, -90° до 90°): долгота (градусов, -180° до 180°): агент (до 255 симв.):

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 здесь!