v0.2.3-beta

oleh

Kepintaran Dilepaskan

log masuk daftar

produk sosial majalah new

log masuk daftar

brainful pustaka API

Navigasi pantas

gambaran keseluruhan mula bermula pengesahan cipta blok tambah ke blok dapatkan blok dapatkan inspirasi

gambaran keseluruhan

Ini brainful API membolehkan integrasi lancar antara aplikasi anda dan brainful's berkuasa sistem pengurusan kandungan. Sama ada anda membina alat automasi atau mengintegrasikan dengan aplikasi kegemaran anda, kami API RESTFUL menyediakan cara yang mudah dan selamat untuk berinteraksi dengan kandungan andamenyediakan cara mudah dan selamat untuk berinteraksi dengan kandungan anda.

Ciri utama

Pengesahan selamat

Pengesahan berasaskan token dengan penyulitan https

Reka bentuk RESTful

Kaedah http standard dengan respons json

Sokongan lokasi

Keupayaan geolokasi terbina dalam

Had kadar

Dioptimumkan untuk prestasi yang boleh dipercayai

Kes penggunaan

Automasi peribadi

Auto-simpan nota daripada aplikasi kegemaran anda
Cipta pencetus kandungan berasaskan lokasi
Sambung dengan IFTTT/Zapier aliran kerja

Penyelesaian integrasi

Bina integrasi dan sambungan tersuai
Cipta aliran kerja kandungan automatik
Bangunkan sistem pengurusan kandungan

Keperluan

Had kadar

60 permintaan per minit per pengguna

Mula bermula

Dapatkan token api anda

Lawati anda brainful halaman pilihan untuk menjana token api anda.

Pilih kaedah integrasi anda

Pilih daripada kod contoh kami dalam cURL, JavaScript, atau Python untuk bermula dengan cepat.

Buat permintaan pertama anda

Cuba contoh interaktif di bawah untuk menguji integrasi anda.

pengesahan

Semua permintaan API memerlukan token API anda dalam header Authorization. Dapatkan token anda daripada brainful halaman pilihan. Api menyokong kedua-dua format token dan bearer token.

Token api anda:

Authorization: Token YOUR_API_TOKEN

Authorization: Bearer YOUR_API_TOKEN

cipta blok

POSThttps://brainful.dev/blocks/add

Parameter permintaan

Semua parameter dihantar dalam badan permintaan sebagai JSON.

Parameter	Jenis	Diperlukan	Penerangan
rentetan	rentetan	Ya	Kandungan untuk ditambah (1-5000 aksara)
parent_luid	rentetan	Tidak	luid blok induk (pilihan)
latitude	apung	Tidak	latitud (-90° ke 90°)
longitude	apung	Tidak	longitud (-180° ke 180°)
agent	rentetan	Tidak	Agent identifier (max 50 chars)
team_space	rentetan	Tidak	Team space slug to add the block to (only for organization members)

Kandungan rentetan:Blok induk luid: latitud (darjah, -90° ke 90°): longitud (darjah, -180° ke 180°): ejen (sehingga 255 aksara):Slug ruang pasukan:

Generated Request

Contoh respons

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

Medan respons

luid

Jenis: rentetan

Pengecam unik untuk kandungan yang dicipta

slug

Jenis: rentetan

URL-friendly version of the content

words

Jenis: integer

Number of words in the content

remaining_daily_quota

Jenis: integer

Remaining content creation quota for today

Kod respons

201Dicipta (berjaya)

400Permintaan buruk (rentetan tidak sah)

401Tidak dibenarkan (token tidak sah)

403Forbidden (plan not sufficient)

422Invalid location coordinates

tambah ke blok

POSThttps://brainful.dev/blocks/append

Parameter permintaan

Semua parameter dihantar dalam badan permintaan sebagai JSON.

Parameter	Jenis	Diperlukan	Penerangan
identifier	rentetan	Ya	Pengecam blok untuk ditambah (luid atau slug)
rentetan	rentetan	Ya	Kandungan untuk ditambah (1-5000 aksara)

Contoh respons

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

Medan respons

luid

Jenis: rentetan

Pengecam unik untuk kandungan yang dicipta

slug

Jenis: rentetan

URL-friendly version of the content

words

Jenis: integer

Number of words in the content

remaining_daily_quota

Jenis: integer

Remaining content creation quota for today

Kod respons

201Dicipta (berjaya)

400Permintaan buruk (rentetan tidak sah)

401Tidak dibenarkan (token tidak sah)

403Forbidden (plan not sufficient)

dapatkan blok

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

Parameter permintaan

URL Parameters

Parameter	Jenis	Diperlukan	Penerangan
luid	rentetan	Ya	Pengecam unik blok untuk diambil

Badan permintaan

Parameter	Jenis	Diperlukan	Penerangan
latitude	apung	Tidak	latitud (-90° ke 90°)
longitude	apung	Tidak	longitud (-180° ke 180°)
agent	rentetan	Tidak	Pengecam ejen (maksimum 50 aksara)

blok LUID (6 aksara): latitud (darjah, -90° ke 90°): longitud (darjah, -180° ke 180°): ejen (sehingga 255 aksara):

Generated Request

Contoh respons

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

Medan respons

creator

Jenis: rentetan

Username of the content creator

luid

Jenis: rentetan

Pengecam unik untuk blok

type

Jenis: rentetan

Jenis kandungan (cth., "thought")

html

Jenis: rentetan

HTML kandungan blok

created_timestamp

Jenis: rentetan

Creation date and time

hits

Jenis: integer

Number of views

Kod respons

200Berjaya (blok dijumpai)

401Tidak dibenarkan (token tidak sah)

403Forbidden (plan not sufficient)

404Tidak dijumpai (blok tidak dijumpai)

Rasa terinspirasi?

Lihat beberapa integrasi rasmi kami yang dibina dengan brainful User API di sini!