Дошка — анлайн-дошка для заняткаў, сустрэч і каманднай працы
API Дошкі для распрацоўшчыкаў
REST API і вебхукі, каб ствараць дошкі, чытаць і змяняць іх змесціва са сваіх праграм: стыкеры з задачамі з трэкера і здзелкамі з CRM, схемы з фігур і стрэлак, праўка і выдаленне элементаў, падзеі пра новыя стыкеры і каментарыі. Фармат — JSON, адрас — https://doshka-online.by/api/v1.
Ключ API
- Увайдзіце ў Дошку і на галоўнай націсніце «Ключы API» → «Стварыць ключ».
- Ключ (пачынаецца з dk_) паказваецца адзін раз — захавайце яго як пароль.
- Ключ дае тыя ж правы, што ў яго ўладальніка: асабістыя дошкі і дошкі яго арганізацый.
- Ключ, які ўцёк ці непатрэбны, выдаліце там жа — запыты з ім адразу перастануць праходзіць.
Кожны запыт — з загалоўкам Authorization: Bearer і ваш ключ.
Метады
- GET /api/v1/me — уладальнік ключа: id, пошта, імя.
- GET /api/v1/boards — дошкі: id, назва, арганізацыя, дата стварэння.
- POST /api/v1/boards — стварыць дошку; у целе можна перадаць title і orgId.
- GET /api/v1/boards/ID — дошка і яе элементы: тып, каардынаты, памер, тэкст, колер стыкера.
- PATCH /api/v1/boards/ID — перайменаваць дошку: у целе title.
- POST /api/v1/boards/ID/stickers — дадаць стыкеры, да 100 за раз; без x і y яны стануць радамі пад усім, што ўжо ёсць на дошцы.
- POST /api/v1/boards/ID/elements — намаляваць фігуры, надпісы і стрэлкі, да 200 за раз — падрабязней у раздзеле «Схемы».
- PATCH /api/v1/boards/ID/elements/ID — змяніць элемент: text, color, x, y, width, height, link — перадайце толькі тое, што мяняецца.
- DELETE /api/v1/boards/ID/elements/ID — выдаліць элемент разам з подпісам; прывязаныя стрэлкі застаюцца, але адвязваюцца.
- GET /api/v1/webhooks — вашы вебхукі і іх стан.
- POST /api/v1/webhooks — падпісацца на падзеі дошкі: boardId, адрас https://… вашага сервера і спіс events; у адказе сакрэт для праверкі подпісу (паказваецца адзін раз).
- DELETE /api/v1/webhooks/ID — адпісацца.
Стыкер: text, color і па жаданні x, y. Колеры: yellow, green, blue, pink, orange, violet, red, teal, lime, cyan, gray, white.
Абмежаванне — 120 запытаў у хвіліну на ключ, пры перавышэнні — адказ 429.
Прыклад: дадаць стыкер
curl, Python і JavaScript — адзін і той жа запыт.
curl -X POST https://doshka-online.by/api/v1/boards/BOARD_ID/stickers \
-H "Authorization: Bearer dk_..." \
-H "Content-Type: application/json" \
-d '{"stickers":[{"text":"PROJ-12 Login page","color":"pink"}]}'import requests
requests.post(
"https://doshka-online.by/api/v1/boards/BOARD_ID/stickers",
headers={"Authorization": "Bearer dk_..."},
json={"stickers": [{"text": "PROJ-12 Login page", "color": "pink"}]},
)await fetch("https://doshka-online.by/api/v1/boards/BOARD_ID/stickers", {
method: "POST",
headers: { Authorization: "Bearer dk_...", "Content-Type": "application/json" },
body: JSON.stringify({ stickers: [{ text: "PROJ-12 Login page", color: "pink" }] }),
});
Схемы: фігуры і стрэлкі
POST /api/v1/boards/ID/elements прымае спіс elements. type: sticker, rectangle, ellipse, diamond, text або arrow; text — подпіс фігуры, стрэлкі або сам надпіс; color — тыя ж колеры, што ў стыкераў; x, y, width, height, link (толькі https://). Стрэлка злучае from і to — id элемента на дошцы або ref фігуры з таго ж запыту. Стрэлкі прывязаныя: рухаюць фігуру — стрэлка едзе следам. Калі стрэлка спасылаецца на неіснуючы элемент, запыт адхіляецца цалкам і дошка не мяняецца. З полем layout (right або down) фігуры без x і y раскладваюцца самі, як блок-схема: пластамі па стрэлках пад змесцівам дошкі.
curl -X POST https://doshka-online.by/api/v1/boards/BOARD_ID/elements \
-H "Authorization: Bearer dk_..." \
-H "Content-Type: application/json" \
-d '{"layout":"right","elements":[
{"type":"rectangle","ref":"order","text":"Order","color":"blue"},
{"type":"diamond","ref":"paid","text":"Paid?"},
{"type":"ellipse","ref":"ship","text":"Ship","color":"green"},
{"type":"arrow","from":"order","to":"paid"},
{"type":"arrow","from":"paid","to":"ship","text":"yes"}
]}'Праўка праз PATCH рухае фігуру разам з подпісам і канцамі стрэлак. Замацаваны на дошцы элемент API не змяняе (адказ 409).
Вузлы для n8n
Пакет n8n-nodes-doshka: вузел «Doshka» стварае і перайменоўвае дошкі, дадае стыкеры (элементы на ўваходзе ідуць пачкамі па 100), малюе схемы з аўтаматычнай раскладкай, правіць і выдаляе элементы; вузел «Doshka Trigger» запускае працэс, калі стыкер створаны, зменены або выдалены, дададзены каментарый або дошка змянілася, — падпіску на вебхук n8n стварае і выдаляе сам і правярае подпіс кожнага паведамлення. Уліковыя даныя Doshka API — ваш ключ. Для трыгера адрас n8n павінен быць даступны з інтэрнэту па https.
n8n → Settings → Community nodes → Install → n8n-nodes-doshka
MCP-сервер для ШІ-памочнікаў
MCP (Model Context Protocol) — стандарт, па якім ШІ-памочнікі працуюць са знешнімі сэрвісамі. З MCP-серверам Дошкі можна папрасіць памочніка: «раскладзі задачы з гэтага ліста стыкерамі на новай дошцы» або «намалюй схему працэсу заказу» — і ён зробіць гэта сам і дашле спасылку на дошку.
Як падключыць: 1) стварыце ключ API (галоўная Дошкі → «Ключы API»); 2) усталюйце Node.js 18 або навейшы; 3) спампуйце файл https://doshka-online.by/doshka-mcp.mjs — гэта ўвесь сервер, без іншых пакетаў; 4) дадайце яго ў налады памочніка, як у прыкладзе ніжэй (Claude Desktop: «Налады» → «Распрацоўшчык» → «Змяніць канфігурацыю»; Cursor: файл .cursor/mcp.json), замест dk_... — ваш ключ, шлях — дзе ляжыць файл. Праверка: node doshka-mcp.mjs --check.
{
"mcpServers": {
"doshka": {
"command": "node",
"args": ["C:\\Users\\me\\Downloads\\doshka-mcp.mjs"],
"env": { "DOSHKA_API_KEY": "dk_..." }
}
}
}Або без спампоўкі файла — з npm (пакет doshka-mcp), Node.js спампуе яго сам:
{
"mcpServers": {
"doshka": {
"command": "npx",
"args": ["-y", "doshka-mcp"],
"env": { "DOSHKA_API_KEY": "dk_..." }
}
}
}Claude Code — адной камандай:
claude mcp add doshka -e DOSHKA_API_KEY=dk_... -- npx -y doshka-mcpІнструменты: list_boards, create_board, get_board, rename_board, add_stickers, draw_diagram (фігуры без каардынат раскладваюцца самі па стрэлках), update_element, delete_element. Сервер працуе на вашым камп'ютары і звяртаецца толькі да API Дошкі з вашым ключом: Дошка не адпраўляе змесціва дошак у нейрасеткі, гэта робіць выбраны вамі памочнік па вашай просьбе.
Вебхукі
- Падзеі: board.changed — зводка: колькі элементаў дадалі, змянілі і выдалілі, колькі каментарыяў і хто правіў; sticker.created, sticker.updated, sticker.deleted — самі стыкеры: id, тэкст, колер, месца, спасылка; comment.added — тэкст каментарыя і элемент, да якога ён пакінуты. Без events прыходзіць толькі board.changed.
- Праўкі за 5 секунд збіраюцца: на кожную падзею — адзін POST, у items да 100 запісаў, загаловак X-Doshka-Event — імя падзеі. На гэтым зручна будаваць трыгеры ў n8n, Make і Zapier: «новы стыкер → задача ў трэкеры», «каментарый → паведамленне ў чат».
- Загаловак X-Doshka-Signature змяшчае sha256= і HMAC-SHA256 цела запыту з сакрэтам падпіскі — звярыце яго, перш чым давяраць запыту.
- Адрас — толькі https на порце 443, не ва ўнутранай сетцы, без пераадрасацый; адказ чакаем 5 секунд. Пасля 20 няўдач запар падпіска выключаецца. Не больш за 20 вебхукаў на ўліковы запіс.
{
"boardId": "BOARD_ID",
"url": "https://example.com/doshka-hook",
"events": ["sticker.created", "comment.added"]
}{
"event": "sticker.created",
"boardId": "…",
"title": "…",
"at": "2026-11-16T10:00:00.000Z",
"by": ["…"],
"items": [{ "id": "…", "text": "PROJ-12 Login page", "color": "pink", "x": 320, "y": 240 }]
}Праверка подпісу (Node.js):
import { createHmac, timingSafeEqual } from "node:crypto";
// rawBody — the raw request body (Buffer), secret — whsec_… from the subscription response
function isFromDoshka(rawBody, signature, secret) {
const expected = Buffer.from("sha256=" + createHmac("sha256", secret).update(rawBody).digest("hex"));
const got = Buffer.from(String(signature ?? ""));
return got.length === expected.length && timingSafeEqual(got, expected);
}
Убудаванне і oEmbed
Код iframe — у «Падзяліцца» → «Убудаваць на сайт». Убудаваная дошка толькі для прагляду і абнаўляецца ўжывую.
oEmbed: GET /oembed?url= і спасылка на дошку «Толькі прагляд». Адказ — type rich з кодам iframe. Памылкі: 404 — не спасылка на дошку, 401 — доступ па спасылцы выключаны або на дошцы пароль.
Апісанне API для праграм
Машыначытальнае апісанне API (OpenAPI 3.1) — яго можна імпартаваць у Postman, n8n, Make і генератары кліентаў: https://doshka-online.by/openapi.json
Памылкі
Адказ з кодам не 2xx змяшчае поле error з тэкстам памылкі, у праўкі элементаў — яшчэ code (missing, locked, geometry, color, link, text). 400 — няправільнае цела запыту, 401 — няма ключа або ён няправільны, 404 — дошкі або элемента няма ці да іх няма правоў, 409 — элемент замацаваны, 429 — занадта часта.
Даведка · Інструкцыі · Пытанні і адказы · Пераезд з Miro · Пераезд з Holst · Дошка і іншыя анлайн-дошкі: сумленнае параўнанне · Мовы, якія падтрымліваюцца · Інтэграцыі Дошкі · API Дошкі для распрацоўшчыкаў · Пра сэрвіс · Карыстальніцкае пагадненне · Палітыка канфідэнцыйнасці · Кантакты · Ліцэнзіі · Шаблоны · Для каго · Артыкулы
Іншыя мовы: Русский · Қазақша · Oʻzbekcha · Кыргызча · Тоҷикӣ · Հայերեն · Azərbaycanca · Română · Türkmençe · Latviešu · Lietuvių · Polski · Eesti · English