v0.2.3-beta
giriş yap kayıt ol

brainful API kütüphanesi

genel bakış

Bu brainful API uygulamalarınız ile arasında kesintisiz entegrasyon sağlar brainful's güçlü içerik yönetim sistemi. Otomasyon araçları oluşturuyor veya favori uygulamalarınızla entegre ediyor olun, bizim RESTFUL API içeriğinizle etkileşim kurmak için basit ve güvenli bir yol sağlar.

Anahtar özellikler

Güvenli kimlik doğrulama

HTTPS şifrelemesi ile token tabanlı kimlik doğrulama

RESTful tasarım

JSON yanıtları ile standart HTTP yöntemleri

Konum desteği

Yerleşik coğrafi konum yetenekleri

Hız sınırlı

Güvenilir performans için optimize edilmiş

Kullanım durumları

Kişisel otomasyon

  • Favori uygulamalarınızdan notları otomatik kaydet
  • Konum tabanlı içerik tetikleyicileri oluştur
  • Bağlan IFTTT/Zapier iş akışları

Entegrasyon çözümleri

  • Özel entegrasyonlar ve uzantılar oluştur
  • Otomatik içerik iş akışları oluştur
  • Geliştir içerik yönetim sistemleri

Gereksinimler

Hız sınırları

60 kullanıcı başına dakikada istek

Başlangıç

1

API tokenınızı alın

Ziyaret edin brainful seçenekler sayfası API tokenınızı oluşturmak için.

2

Entegrasyon yönteminizi seçin

Içindeki örnek kodumuzdan seçin cURL, JavaScript, veya Python hızlı başlamak için.

3

Ilk isteğinizi yapın

Entegrasyonunuzu test etmek için aşağıdaki etkileşimli örnekleri deneyinentegrasyonunuzu test etmek için aşağıdaki etkileşimli örnekleri deneyin.

kimlik doğrulama

Tüm API istekleri Authorization başlığında API tokenınızı gerektirir. Tokenınızı şuradan alın brainful seçenekler sayfası. API hem token hem de bearer token formatlarını destekler.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

blok oluştur

POSThttps://brainful.dev/blocks/add

Istek parametreleri

Tüm parametreler istek gövdesinde şu şekilde gönderilir JSON.

ParametreTipGerekliAçıklama
metinmetinEvetEklenecek içerik (1-5000 karakter)
parent_luidmetinHayırluid üst bloğun (isteğe bağlı)
latitudeondalık sayıHayırenlem (-90° hedef 90°)
longitudeondalık sayıHayırboylam (-180° hedef 180°)
agentmetinHayırAgent identifier (max 50 chars)
team_spacemetinHayırTeam space slug to add the block to (only for organization members)

Generated Request

Örnek yanıt

{
                    "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
                  }

Yanıt alanları

luid

Tip: metin

Oluşturulan içerik için benzersiz tanımlayıcı

slug

Tip: metin

URL-friendly version of the content

words

Tip: tam sayı

Number of words in the content

remaining_daily_quota

Tip: tam sayı

Remaining content creation quota for today

Yanıt kodları

201Oluşturuldu (başarılı)
400Hatalı istek (geçersiz metin)
401Yetkisiz (geçersiz token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

bloğa ekle

POSThttps://brainful.dev/blocks/append

Istek parametreleri

Tüm parametreler istek gövdesinde şu şekilde gönderilir JSON.

ParametreTipGerekliAçıklama
identifiermetinEvet Eklenecek bloğun tanımlayıcısı (luid veya slug)
metinmetinEvetEklenecek içerik (1-5000 karakter)

Generated Request

Örnek yanıt

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

Yanıt alanları

luid

Tip: metin

Oluşturulan içerik için benzersiz tanımlayıcı

slug

Tip: metin

URL-friendly version of the content

words

Tip: tam sayı

Number of words in the content

remaining_daily_quota

Tip: tam sayı

Remaining content creation quota for today

Yanıt kodları

201Oluşturuldu (başarılı)
400Hatalı istek (geçersiz metin)
401Yetkisiz (geçersiz token)
403Forbidden (plan not sufficient)

blok al

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

Istek parametreleri

URL Parameters

ParametreTipGerekliAçıklama
luidmetinEvetAlınacak bloğun benzersiz tanımlayıcısı

Istek gövdesi

ParametreTipGerekliAçıklama
latitudeondalık sayıHayırenlem (-90° hedef 90°)
longitudeondalık sayıHayırboylam (-180° hedef 180°)
agentmetinHayır Ajan tanımlayıcısı (maksimum 50 karakter)

Generated Request

Örnek yanıt

{
  "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 }

Yanıt alanları

creator

Tip: metin

Username of the content creator

luid

Tip: metin

Blok için benzersiz tanımlayıcı

type

Tip: metin

Içerik türü (örn., "thought")

html

Tip: metin

HTML bloğun içeriği

created_timestamp

Tip: metin

Creation date and time

hits

Tip: tam sayı

Number of views

Yanıt kodları

200Başarılı (blok bulundu)
401Yetkisiz (geçersiz token)
403Forbidden (plan not sufficient)
404Bulunamadı (blok bulunamadı)

Ilham alın?

brainful User API ile oluşturulmuş resmi entegrasyonlarımızdan bazılarına göz atınbrainful User API ile oluşturulmuş resmi entegrasyonlarımızdan bazılarına göz atınız burada!