v0.2.3-beta
iniciar sessão registar

brainful biblioteca da API

visão geral

O brainful API permite integração perfeita entre as suas aplicações e brainful's poderoso sistema de gestão de conteúdo. Quer esteja a construir ferramentas de automação ou a integrar com as suas aplicações favoritas, a nossa API RESTFUL fornece uma forma simples e segura de interagir com o seu conteúdo.

Características principais

Autenticação segura

Autenticação baseada em token com encriptação HTTPS

Design RESTful

Métodos HTTP padrão com respostas JSON

Suporte de localização

Capacidades de geolocalização integradas

Com limite de taxa

Optimizada para desempenho fiável

Casos de uso

Automação pessoal

  • Guardar automaticamente notas das suas aplicações favoritas
  • Criar gatilhos de conteúdo baseados na localização
  • Conectar com IFTTT/Zapier fluxos de trabalho

Soluções de integração

  • Construir integrações e extensões personalizadas
  • Criar fluxos de trabalho de conteúdo automatizados
  • Desenvolver sistemas de gestão de conteúdo

Requisitos

Limites de taxa

60 pedidos por minuto por utilizador

Como começar

1

Obter o seu token da API

Visite a sua brainful página de opções para gerar o seu token da API.

2

Escolha o seu método de integração

Selecione do nosso código de exemplo em cURL, JavaScript, ou Python para começar rapidamente.

3

Faça o seu primeiro pedido

Experimente os exemplos interativos abaixo para testar a sua integração.

autenticação

All API requests require your API token in the Authorization header. Get your token from the brainful página de opções. The api supports both token and bearer token formats.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

criar bloco

POSThttps://brainful.dev/blocks/add

Parâmetros do pedido

Todos os parâmetros são enviados no corpo do pedido como JSON.

ParâmetroTipoObrigatórioDescrição
stringstringSimConteúdo a ser adicionado (1-5000 carateres)
parent_luidstringNãoluid do bloco pai (opcional)
latitudefloatNãolatitude (-90° para 90°)
longitudefloatNãolongitude (-180° para 180°)
agentstringNãoAgent identifier (max 50 chars)
team_spacestringNãoTeam space slug to add the block to (only for organization members)

Generated Request

Resposta de exemplo

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

Campos da resposta

luid

Tipo: string

Identificador único para o conteúdo criado

slug

Tipo: string

URL-friendly version of the content

words

Tipo: inteiro

Number of words in the content

remaining_daily_quota

Tipo: inteiro

Remaining content creation quota for today

Códigos de resposta

201Criado (sucesso)
400Pedido inválido (string inválida)
401Não autorizado (token inválido)
403Forbidden (plan not sufficient)
422Invalid location coordinates

anexar ao bloco

POSThttps://brainful.dev/blocks/append

Parâmetros do pedido

Todos os parâmetros são enviados no corpo do pedido como JSON.

ParâmetroTipoObrigatórioDescrição
identifierstringSim Identificador do bloco ao qual anexar (luid ou slug)
stringstringSimConteúdo a ser anexado (1-5000 carateres)

Generated Request

Resposta de exemplo

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

Campos da resposta

luid

Tipo: string

Identificador único para o conteúdo criado

slug

Tipo: string

URL-friendly version of the content

words

Tipo: inteiro

Number of words in the content

remaining_daily_quota

Tipo: inteiro

Remaining content creation quota for today

Códigos de resposta

201Criado (sucesso)
400Pedido inválido (string inválida)
401Não autorizado (token inválido)
403Forbidden (plan not sufficient)

obter bloco

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

Parâmetros do pedido

URL Parameters

ParâmetroTipoObrigatórioDescrição
luidstringSimIdentificador único do bloco a recuperar

Corpo do pedido

ParâmetroTipoObrigatórioDescrição
latitudefloatNãolatitude (-90° para 90°)
longitudefloatNãolongitude (-180° para 180°)
agentstringNão Identificador do agente (máximo 50 carateres)

Generated Request

Resposta de exemplo

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

Campos da resposta

creator

Tipo: string

Username of the content creator

luid

Tipo: string

Identificador único para o bloco

type

Tipo: string

Tipo de conteúdo (ex., "thought")

html

Tipo: string

HTML conteúdo do bloco

created_timestamp

Tipo: string

Creation date and time

hits

Tipo: inteiro

Number of views

Códigos de resposta

200Sucesso (bloco encontrado)
401Não autorizado (token inválido)
403Forbidden (plan not sufficient)
404Não encontrado (bloco não encontrado)

Sinta-se inspirado?

dê uma olhada em algumas das nossas integrações oficiais construídas com brainful User API aqui!