v0.2.3-beta
connexion enregistrement

brainful bibliothèque API

aperçu

Le brainful API permet une intégration transparente entre vos applications et brainful's puissant système de gestion de contenu. Que vous construisiez des outils d'automatisation ou que vous intégriez vos applications préférées, notre API RESTFUL fournit un moyen simple et sécurisé d'interagir avec votre contenu.

Fonctionnalités clés

Authentification sécurisée

Authentification basée sur des jetons avec chiffrement HTTPS

Conception RESTful

Méthodes HTTP standard avec réponses JSON

Support de localisation

Capacités de géolocalisation intégrées

Limité en débit

Optimisé pour une performance fiable

Cas d'utilisation

Automatisation personnelle

  • Sauvegarde automatique des notes de vos applications préférées
  • Créer des déclencheurs de contenu basés sur la localisation
  • Se connecter avec IFTTT/Zapier flux de travail

Solutions d'intégration

  • Créer des intégrations et extensions personnalisées
  • Créer des flux de travail de contenu automatisés
  • Développer systèmes de gestion de contenu

Exigences

Limites de débit

60 requêtes par minute par utilisateur

Commencer

1

Obtenir votre jeton API

Visitez votre brainful page d'options pour générer votre jeton API.

2

Choisissez votre méthode d'intégration

Sélectionnez parmi nos exemples de code en cURL, JavaScript, ou Python pour commencer rapidement.

3

Faites votre première requête

Essayez les exemples interactifs ci-dessous pour tester votre intégrationessayez les exemples interactifs ci-dessous pour tester votre intégration.

authentification

Toutes les requêtes API nécessitent votre jeton API dans l'en-tête Authorization. Obtenez votre jeton depuis la brainful page d'options. L'API prend en charge les formats de jeton et de jeton porteur.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

créer un bloc

POSThttps://brainful.dev/blocks/add

Paramètres de requête

Tous les paramètres sont envoyés dans le corps de la requête comme JSON.

ParamètreTypeRequisDescription
chaîne de caractèreschaîne de caractèresOuiContenu à ajouter (1-5000 caractères)
parent_luidchaîne de caractèresNonluid du bloc parent (optionnel)
latitudeflottantNonlatitude (-90° à 90°)
longitudeflottantNonlongitude (-180° à 180°)
agentchaîne de caractèresNonAgent identifier (max 50 chars)
team_spacechaîne de caractèresNonTeam space slug to add the block to (only for organization members)

Generated Request

Exemple de réponse

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

Champs de réponse

luid

Type: chaîne de caractères

Identifiant unique pour le contenu créé

slug

Type: chaîne de caractères

URL-friendly version of the content

words

Type: entier

Number of words in the content

remaining_daily_quota

Type: entier

Remaining content creation quota for today

Codes de réponse

201Créé (succès)
400Mauvaise requête (chaîne invalide)
401Non autorisé (jeton invalide)
403Forbidden (plan not sufficient)
422Invalid location coordinates

ajouter au bloc

POSThttps://brainful.dev/blocks/append

Paramètres de requête

Tous les paramètres sont envoyés dans le corps de la requête comme JSON.

ParamètreTypeRequisDescription
identifierchaîne de caractèresOui Identifiant du bloc auquel ajouter (luid ou slug)
chaîne de caractèreschaîne de caractèresOuiContenu à ajouter (1-5000 caractères)

Generated Request

Exemple de réponse

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

Champs de réponse

luid

Type: chaîne de caractères

Identifiant unique pour le contenu créé

slug

Type: chaîne de caractères

URL-friendly version of the content

words

Type: entier

Number of words in the content

remaining_daily_quota

Type: entier

Remaining content creation quota for today

Codes de réponse

201Créé (succès)
400Mauvaise requête (chaîne invalide)
401Non autorisé (jeton invalide)
403Forbidden (plan not sufficient)

obtenir le bloc

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

Paramètres de requête

URL Parameters

ParamètreTypeRequisDescription
luidchaîne de caractèresOuiIdentifiant unique du bloc à récupérer

Corps de requête

ParamètreTypeRequisDescription
latitudeflottantNonlatitude (-90° à 90°)
longitudeflottantNonlongitude (-180° à 180°)
agentchaîne de caractèresNon Identifiant d'agent (max 50 caractères)

Generated Request

Exemple de réponse

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

Champs de réponse

creator

Type: chaîne de caractères

Username of the content creator

luid

Type: chaîne de caractères

Identifiant unique pour le bloc

type

Type: chaîne de caractères

Type de contenu (p. ex., "thought")

html

Type: chaîne de caractères

HTML contenu du bloc

created_timestamp

Type: chaîne de caractères

Creation date and time

hits

Type: entier

Number of views

Codes de réponse

200Succès (bloc trouvé)
401Non autorisé (jeton invalide)
403Forbidden (plan not sufficient)
404Non trouvé (bloc non trouvé)

Sentez-vous inspiré?

Découvrez certaines de nos intégrations officielles construites avec brainful User APIJetez un coup d'œil à certaines de nos intégrations officielles conçues avec brainful User API ici!