v0.2.3-beta
log ind registrer

brainful API-bibliotek

oversigt

Det brainful API muliggør sømløs integration mellem Deres applikationer og brainful's kraftfulde indholdsstyringssystem. Hvad enten De bygger automatiseringsværktøjer eller integrerer med Deres yndlings-apps, vores RESTFUL API giver en enkel og sikker måde at interagere med Deres indhold.

Nøglefunktioner

Sikker autentificering

Token-baseret autentificering med HTTPS-kryptering

RESTful design

Standard HTTP-metoder med JSON-svar

Lokationsstøtte

Indbyggede geolokationsevner

Hastighedsbegrænset

Optimeret for pålidelig ydeevne

Anvendelsestilfælde

Personlig automatisering

  • Gem automatisk noter fra Deres yndlingsapps
  • Opret lokationsbaserede indholdsudløsere
  • Forbind med IFTTT/Zapier workflows

Integrationsløsninger

  • Byg tilpassede integrationer og udvidelser
  • Opret automatiserede indholdsworkflows
  • Udvikle content management systemer

Krav

Hastighedsbegrænsninger

60 forespørgsler per minut per bruger

Kom i gang

1

Få Deres API-token

Besøg Deres brainful indstillingsside for at generere Deres API-token.

2

Vælg Deres integrationsmetode

Vælg fra vores eksempelkode i cURL, JavaScript, eller Python for at komme hurtigt i gang.

3

Lav Deres første forespørgsel

Prøv de interaktive eksempler nedenfor for at teste Deres integration.

autentificering

Alle API-forespørgsler kræver Deres API-token i Authorization-headeren. Få Deres token fra brainful indstillingsside. API'en understøtter både token- og bearer token-formater.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

opret blok

POSThttps://brainful.dev/blocks/add

Anmodningsparametre

Alle parametre sendes i anmodningskroppen som JSON.

ParameterTypePåkrævetBeskrivelse
strengstrengJaIndhold der skal tilføjes (1-5000 tegn)
parent_luidstrengNejluid af forældreblokken (valgfri)
latitudekommatalNejbreddegrad (-90° til 90°)
longitudekommatalNejlændegrad (-180° til 180°)
agentstrengNejAgent identifier (max 50 chars)
team_spacestrengNejTeam space slug to add the block to (only for organization members)

Generated Request

Eksempel på svar

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

Svarfelter

luid

Type: streng

Unik identifikator for det oprettede indhold

slug

Type: streng

URL-friendly version of the content

words

Type: heltal

Number of words in the content

remaining_daily_quota

Type: heltal

Remaining content creation quota for today

Svarkoder

201Oprettet (succes)
400Forkert anmodning (ugyldig streng)
401Uautoriseret (ugyldigt token)
403Forbidden (plan not sufficient)
422Invalid location coordinates

føj til blok

POSThttps://brainful.dev/blocks/append

Anmodningsparametre

Alle parametre sendes i anmodningskroppen som JSON.

ParameterTypePåkrævetBeskrivelse
identifierstrengJa Identifikator for blokken, der skal føjes til (luid eller slug)
strengstrengJaIndhold, der skal føjes (1-5000 tegn)

Generated Request

Eksempel på svar

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

Svarfelter

luid

Type: streng

Unik identifikator for det oprettede indhold

slug

Type: streng

URL-friendly version of the content

words

Type: heltal

Number of words in the content

remaining_daily_quota

Type: heltal

Remaining content creation quota for today

Svarkoder

201Oprettet (succes)
400Forkert anmodning (ugyldig streng)
401Uautoriseret (ugyldigt token)
403Forbidden (plan not sufficient)

få blok

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

Anmodningsparametre

URL Parameters

ParameterTypePåkrævetBeskrivelse
luidstrengJaUnik identifikator for blokken, der skal hentes

Forespørgselskrop

ParameterTypePåkrævetBeskrivelse
latitudekommatalNejbreddegrad (-90° til 90°)
longitudekommatalNejlændegrad (-180° til 180°)
agentstrengNej Agent-identifikator (maks 50 tegn)

Generated Request

Eksempel på svar

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

Svarfelter

creator

Type: streng

Username of the content creator

luid

Type: streng

Unik identifikator for blokken

type

Type: streng

Indholdstype (f.eks., "thought")

html

Type: streng

HTML indholdet af blokken

created_timestamp

Type: streng

Creation date and time

hits

Type: heltal

Number of views

Svarkoder

200Succes (blok fundet)
401Uautoriseret (ugyldigt token)
403Forbidden (plan not sufficient)
404Ikke fundet (blok ikke fundet)

Få inspiration?

Tag et kig på nogle af vores officielle integrationer bygget med brainful User API her!