v0.2.3-beta
login register

brainful bibliotecă API

prezentare generală

The brainful API permite integrarea fără întrerupere între aplicațiile dumneavoastră și brainful's puternic sistem de management conținut. Fie că construiți unelte de automatizare sau integrați cu aplicațiile dumneavoastră preferate, al nostru API RESTFUL oferă o modalitate simplă și sigură de a interacționa cu conținutul dumneavoastră.

Funcționalități cheie

Autentificare sigură

Autentificare bazată pe token cu criptare HTTPS

Design RESTful

Metode HTTP standard cu răspunsuri JSON

Suport locație

Capacități de geolocalizare integrate

Limitată rată

Optimizat pentru performanță fiabilă

Cazuri de utilizare

Automatizare personală

  • Salvare automată de notițe din aplicațiile dumneavoastră preferate
  • Creați declansatori de conținut bazati pe locație
  • Conectați-vă cu IFTTT/Zapier fluxuri de lucru

Soluții de integrare

  • Construiți integrări și extensii personalizate
  • Creați fluxuri de conținut automatizate
  • Dezvoltați sisteme de management conținut

Cerințe

Limite de rată

60 cereri pe minut pe utilizator

Începere

1

Obțineți token-ul API

Vizitați brainful pagina opțiuni pentru a genera token-ul API.

2

Alegeți metoda de integrare

Selectați din codul nostru exemplu în cURL, JavaScript, sau Python pentru a începe rapid.

3

Faceți prima cerere

Încearcați exemplele interactive de mai jos pentru a testa integrarea.

autentificare

toate cererile API necesită token-ul API în antetul Authorization. Obțineți token-ul din brainful pagina opțiuni. API-ul suportă atât formatele token cât și bearer token.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

creează bloc

POSThttps://brainful.dev/blocks/add

Parametri cerere

Toți parametrii sunt trimiși în corpul cererii ca JSON.

ParametruTipNecesarDescriere
stringstringDaContent to be added (1-5000 caractere)
parent_luidstringNuluid al blocului părinte (opțional)
latitudefloatNulatitudine (-90° către 90°)
longitudefloatNulongitudine (-180° către 180°)
agentstringNuAgent identifier (max 50 chars)
team_spacestringNuTeam space slug to add the block to (only for organization members)

Generated Request

Răspuns exemplu

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

Câmpurile răspunsului

luid

Tip: string

Identificator unic pentru conținutul creat

slug

Tip: string

URL-friendly version of the content

words

Tip: număr întreg

Number of words in the content

remaining_daily_quota

Tip: număr întreg

Remaining content creation quota for today

Codurile răspunsului

201Creat (succes)
400Cerere greșită (text nevalid)
401Neautorizat (token nevalid)
403Forbidden (plan not sufficient)
422Invalid location coordinates

adăugați la bloc

POSThttps://brainful.dev/blocks/append

Parametri cerere

Toți parametrii sunt trimiși în corpul cererii ca JSON.

ParametruTipNecesarDescriere
identifierstringDa Identificatorul blocului la care să se adauge (luid sau slug)
stringstringDaConținutul care urmează să fie adăugat (1-5000 caractere)

Generated Request

Răspuns exemplu

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

Câmpurile răspunsului

luid

Tip: string

Identificator unic pentru conținutul creat

slug

Tip: string

URL-friendly version of the content

words

Tip: număr întreg

Number of words in the content

remaining_daily_quota

Tip: număr întreg

Remaining content creation quota for today

Codurile răspunsului

201Creat (succes)
400Cerere greșită (text nevalid)
401Neautorizat (token nevalid)
403Forbidden (plan not sufficient)

obține bloc

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

Parametri cerere

URL Parameters

ParametruTipNecesarDescriere
luidstringDaIdentificator unic al blocului de recuperat

Corpul cererii

ParametruTipNecesarDescriere
latitudefloatNulatitudine (-90° către 90°)
longitudefloatNulongitudine (-180° către 180°)
agentstringNu Identificator agent (maxim 50 caractere)

Generated Request

Răspuns exemplu

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

Câmpurile răspunsului

creator

Tip: string

Username of the content creator

luid

Tip: string

Identificator unic pentru bloc

type

Tip: string

Tipul conținutului (de ex., "thought")

html

Tip: string

HTML conținutul blocului

created_timestamp

Tip: string

Creation date and time

hits

Tip: număr întreg

Number of views

Codurile răspunsului

200Succes (bloc găsit)
401Neautorizat (token nevalid)
403Forbidden (plan not sufficient)
404Negăsit (bloc negăsit)

Inspirați-vă?

aruncăți o privire la câteva din integrările noastre oficiale construite cu brainful User API aici!