v0.2.3-beta
login magrehistro

brainful Aklatan ng API

hapyaw

Ang brainful API nagbibigay-daan sa tuluy-tuloy na pagsasama ng iyong mga aplikasyon at brainful's makapangyarihan sistema ng pamamahala ng nilalaman. Ikaw man ay lumilikha ng mga kagamitang pang-awtomasyon o nagsasama ng mga ito sa iyong mga paboritong aplikasyon, ang aming RESTFUL API nagbibigay ng isang payak at ligtas na paraan upang makipag-ugnayan sa iyong nilalaman.

Mga pangunahing tampok

Ligtas na pagpapatunay ng pagkakakilanlan

Pagpapatunay gamit ang token na may https encryption

Restful design

Karaniwang mga pamamaraan ng http na may mga json responses

Suporta sa lokasyon

Nakalakip na kakayahan sa geolocation

Nililimitahan ang bilis

Inaayos para sa maaasahang performance

Use cases

Personal na awtomasyon

  • Awtomatikong itabi ang mga tala mula sa iyong paboritong apps
  • Lumikha ng mga trigger ng nilalaman batay sa lokasyon
  • Makipag-ugnayan sa IFTTT/Zapier workflows

Mga solusyon para sa integrasyon

  • Bumuo ng pasadyang integrasyon at mga palawig
  • Lumikha ng awtomatikong daloy ng gawain para sa nilalaman
  • Paunlarin mga sistema ng pamamahala ng nilalaman

Mga kinakailangan

Mga limitasyon sa bilis

60 mga kahilingan bawat minuto bawat gumagamit

Pagsisimula

1

Kunin ang iyong api token

Bisitahin ang iyong brainful pahina ng mga opsyon upang lumikha ng iyong api token.

2

Piliin ang iyong paraan ng integrasyon

Pumili mula sa mga halimbawa ng kodigo sa cURL, JavaScript, o Python upang makapagsimula agad.

3

Gawin ang iyong unang kahilingan

Subukan ang mga interaktibong halimbawa sa ibaba upang masuri ang iyong integrasyon.

pagpapatunay ng pagkakakilanlan

Kinakailangan sa bawat kahilingan sa API ang iyong API token na nakasaad sa ulo ng Pahintulot. Kunin ang iyong token mula sa brainful pahina ng mga opsyon. Sinusuportahan ng API ang parehong anyo ng token at taglay na token.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

lumikha ng bloke

POSThttps://brainful.dev/blocks/add

Mga parametro ng kahilingan

Lahat ng parametro ay ipinapadala sa katawan ng kahilingan bilang JSON.

ParametroUriKinakailanganPaglalarawan
anyo ng tekstoanyo ng tekstoOoNilalaman na idadagdag (1-5000 mga karakter)
parent_luidanyo ng tekstoHindiluid ng pangunahing bloke (opsyonal)
latitudelumulutangHindilatitud (-90° patungo 90°)
longitudelumulutangHindilonghitud (-180° patungo 180°)
agentanyo ng tekstoHindiAgent identifier (max 50 chars)
team_spaceanyo ng tekstoHindiTeam space slug to add the block to (only for organization members)

Generated Request

Halimbawang tugon

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

Mga patlang ng tugon

luid

Uri: anyo ng teksto

Natatanging tagatukoy para sa nilikhang nilalaman

slug

Uri: anyo ng teksto

URL-friendly version of the content

words

Uri: bilang na buo

Number of words in the content

remaining_daily_quota

Uri: bilang na buo

Remaining content creation quota for today

Mga kodigo ng tugon

201Nalikha (matagumpay)
400Hindi wastong kahilingan (hindi wastong teksto)
401Walang pahintulot (hindi wastong token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

idugtong sa bloke

POSThttps://brainful.dev/blocks/append

Mga parametro ng kahilingan

Lahat ng parametro ay ipinapadala sa katawan ng kahilingan bilang JSON.

ParametroUriKinakailanganPaglalarawan
identifieranyo ng tekstoOo Ilarawan ang bloke na nais mong dugtungan (luid o slug)
anyo ng tekstoanyo ng tekstoOoNilalaman na idudugtong (1-5000 mga karakter)

Generated Request

Halimbawang tugon

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

Mga patlang ng tugon

luid

Uri: anyo ng teksto

Natatanging tagatukoy para sa nilikhang nilalaman

slug

Uri: anyo ng teksto

URL-friendly version of the content

words

Uri: bilang na buo

Number of words in the content

remaining_daily_quota

Uri: bilang na buo

Remaining content creation quota for today

Mga kodigo ng tugon

201Nalikha (matagumpay)
400Hindi wastong kahilingan (hindi wastong teksto)
401Walang pahintulot (hindi wastong token)
403Forbidden (plan not sufficient)

kunin ang bloke

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

Mga parametro ng kahilingan

URL Parameters

ParametroUriKinakailanganPaglalarawan
luidanyo ng tekstoOoNatatanging tagatukoy ng bloke na kukunin

Katawan ng kahilingan

ParametroUriKinakailanganPaglalarawan
latitudelumulutangHindilatitud (-90° patungo 90°)
longitudelumulutangHindilonghitud (-180° patungo 180°)
agentanyo ng tekstoHindi Tagatukoy ng ahente (max 50 mga titik)

Generated Request

Halimbawang tugon

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

Mga patlang ng tugon

creator

Uri: anyo ng teksto

Username of the content creator

luid

Uri: anyo ng teksto

Natatanging tagatukoy para sa bloke

type

Uri: anyo ng teksto

Uri ng nilalaman (hal., "thought")

html

Uri: anyo ng teksto

HTML nilalaman ng bloke

created_timestamp

Uri: anyo ng teksto

Creation date and time

hits

Uri: bilang na buo

Number of views

Mga kodigo ng tugon

200Matagumpay (natagpuan ang bloke)
401Walang pahintulot (hindi wastong token)
403Forbidden (plan not sufficient)
404Hindi natagpuan (hindi natagpuan ang bloke)

Makadama ng inspirasyon?

Tingnan ang ilang opisyal naming integrasyon na ginawa gamit ang brainful User API dito!