API-Dokumentation

Die LinkBoost-API ist eine einfache JSON-Schnittstelle. Alle Antworten sind JSON, Eingaben schickst du als JSON mit Content-Type: application/json.

Adresse und Anmeldung

• Adresse: https://api.linkboost.one/api/v1
• Anmeldung: Kopfzeile Authorization: Bearer lbo_live_… mit deinem API-Schlüssel. Nie in der Adresszeile.
• Erster Aufruf: GET /api/v1/key-info zeigt Konto, Tarif und die Rechte des Schlüssels.
• Grenze: 60 Anfragen pro Minute und Schlüssel.

Beispiel:

curl https://api.linkboost.one/api/v1/bookmarks?q=steuer \
  -H "Authorization: Bearer lbo_live_DEIN_SCHLUESSEL"

Fehler

• 401 {"error":"invalid_key"}: Schlüssel fehlt, ist unbekannt, widerrufen oder abgelaufen.
• 402 {"error":"plan_required"} bzw. plan_limit: Tarif enthält die API nicht oder eine Tarifgrenze ist erreicht.
• 403 {"error":"missing_scope","required":"bookmarks.write"}: Dem Schlüssel fehlt dieses Recht.
• 403 {"error":"read_only_board"}: Das Board ist nur zum Ansehen mit dir geteilt.
• 404 {"error":"not_found"}: gibt es nicht oder ist für den Schlüssel nicht sichtbar.
• 409 {"error":"contains_locked"}: betrifft eine gesperrte Kategorie, nur im Dashboard möglich.
• 429 {"error":"rate_limited"}: zu viele Anfragen, Kopfzeile Retry-After nennt die Wartezeit in Sekunden.

Lesezeichen

• GET /bookmarks (bookmarks.read): Suche und Liste. Parameter q (Text), board_id, category_id, tag, url (genaue Adresse), limit (1 bis 100, Standard 20), offset.
• GET /bookmarks/{id} (bookmarks.read): ein Lesezeichen.
• POST /bookmarks (bookmarks.write): anlegen. Pflicht url und board_id, optional category_id, title, description, note, tags (Liste), favorite. Ohne Titel holt LinkBoost Titel, Symbol und Vorschau selbst.
• PATCH /bookmarks/{id} (bookmarks.write): ändern oder verschieben. Felder wie beim Anlegen; board_id und category_id verschieben (category_id: null = ohne Kategorie). tags ersetzt die bisherigen Tags.
• DELETE /bookmarks/{id} (bookmarks.delete): löschen.

Ein Lesezeichen sieht so aus: id, url, title, description, note, tags, favorite, board_id, board_name, category_id, category_name, created_at, updated_at.

Boards und Kategorien

• GET /boards (boards.read): alle sichtbaren Boards mit bookmark_count und writable.
• GET /boards/{id} (boards.read): ein Board mit seinen Kategorien (id, name, parent_id).
• POST /boards (boards.write): anlegen, Pflicht name.
• PATCH /boards/{id} (boards.write): umbenennen (name).
• DELETE /boards/{id} (boards.delete): Board samt seinen Lesezeichen löschen.
• POST /boards/{id}/categories (boards.write): Kategorie anlegen, Pflicht name, optional parent_id.
• PATCH /categories/{id} (boards.write): umbenennen (name).
• DELETE /categories/{id} (boards.delete): Kategorie löschen, ihre Lesezeichen bleiben ohne Kategorie erhalten.

Merkliste

• GET /inbox (inbox.read): Einträge, neueste zuerst. Parameter category_id (Zahl oder none), limit (1 bis 100).
• GET /inbox/categories (inbox.read): Kategorien der Merkliste mit Anzahl.
• POST /inbox (inbox.write): Seite merken, Pflicht url, optional title, category_id. Ist die Seite schon gemerkt, rückt sie nach oben (duplicate: true).
• POST /inbox/categories (inbox.write): Kategorie anlegen (name, 1 bis 40 Zeichen).
• POST /inbox/{id}/keep (inbox.write und bookmarks.write): Eintrag als Lesezeichen in ein Board übernehmen, Pflicht board_id, optional category_id, title, note.
• DELETE /inbox/{id} (inbox.delete): Eintrag entfernen.

‹ Zur Hilfe-Übersicht