API e Punës

Fillimi i shpejtë

1. 01

   Krijo çelësin

   Në tabelë, shtyp butonin e llogarisë, pastaj API dhe Krijo çelësin.

2. 02

   Ruaje diku të sigurt

   Çelësi shfaqet i plotë vetëm një herë. Nëse e humbet, ndërroje dhe merr një të ri.

3. 03

   Bëj thirrjen e parë

   Dërgo veprimin me për të parë llogarinë dhe numrin e detyrave.

curl -X POST https://puna.bfzli.com/__fn/api \
  -H "Content-Type: application/json" \
  -d '{"input":{"key":"puna_ÇELËSI_YT","action":"me"}}'

// Përgjigjja
{
  "result": {
    "ok": true,
    "apps": 4,
    "tasks": { "active": 31, "draft": 12, "in_progress": 6, "completed": 13, "trashed": 4 },
    "limits": { "tasks": 2000, "apps": 50, "text": 10000, "requests_per_minute": 120 },
    "email": "ti@shembull.com",
    "requests_left": 119,
    "rev": 128
  }
}

Kërkesa

Çdo veprim shkon te e njëjta adresë, me metodën POST dhe trup JSON. Brenda input vendos çelësin, veprimin dhe fushat e tij.

POST https://puna.bfzli.com/__fn/api
Content-Type: application/json

{
  "input": {
    "key": "puna_ÇELËSI_YT",
    "action": "tasks.create",
    "text": "Përgatit faturën e muajit",
    "status": "in_progress"
  }
}

Një ndihmës i vogël në JavaScript, që mund ta përdorësh në çdo projekt:

const KEY = process.env.PUNA_API_KEY

async function puna(action, params = {}) {
  const res = await fetch('https://puna.bfzli.com/__fn/api', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ input: { key: KEY, action, ...params } })
  })
  const body = await res.json()
  const result = body.result || body
  if (!result.ok) throw new Error(result.message || result.error)
  return result
}

// Merr detyrat në punë dhe kryej të parën
const { tasks } = await puna('tasks.list', { status: 'in_progress' })
await puna('tasks.move', { todo_id: tasks[0].id, status: 'completed', position: 'top' })

Përgjigjja

Përgjigjja vjen gjithmonë brenda result. Kur veprimi ia del, ok është true. Kur jo, vjen ok: false me kodin e gabimit në error dhe një shpjegim në message.

{ "result": { "ok": false, "error": "bad_status", "message": "Status must be draft, in_progress or completed." } }

Çdo përgjigje e suksesshme mban edhe rev, numrin e versionit të listës. Rritet me çdo ndryshim, nga API ose nga tabela, ndaj mjafton ta krahasosh për të ditur nëse diçka ka ndryshuar.

Vetëm kur mungon fusha key ose action, adresa kthen kodin HTTP 400 me një error të shkurtër, pa result.

Kufijtë

Detyra dhe aplikacioni

Detyra

Aplikacioni

Ngjyrat e gatshme: indigo blue sky teal green lime yellow orange red pink fuchsia violet brown black gray.

Të gjitha veprimet

Aplikacionet

{ "input": { "key": "puna_ÇELËSI_YT", "action": "apps.create", "name": "Uebfaqe", "color": "violet", "url": "uebfaqe.app" } }

Detyrat

{ "input": { "key": "puna_ÇELËSI_YT", "action": "tasks.create", "text": "Rregullo formularin e kontaktit", "app_id": "3f9a1c2b7d4e8f60" } }

{ "input": { "key": "puna_ÇELËSI_YT", "action": "tasks.update", "ids": ["a1b2c3d4e5f60718", "0f1e2d3c4b5a6978"], "status": "completed" } }

{ "input": { "key": "puna_ÇELËSI_YT", "action": "tasks.move", "todo_id": "a1b2c3d4e5f60718", "status": "in_progress", "position": "top" } }

Skedarët

Gabimet

Siguria

• Çelësi hap vetëm aplikacionet dhe detyrat e llogarisë tënde, asgjë tjetër.
• Ne nuk e ruajmë çelësin e plotë, vetëm një gjurmë të tij. Prandaj shfaqet vetëm një herë.
• Mbaje në serverin ose skriptin tënd, kurrë në një faqe që e hapin të tjerët.
• Nëse dyshon se e ka parë dikush, ndërroje te Llogaria → API. I vjetri ndalon menjëherë.
• Ndryshimet nga API shfaqen në tabelë herën tjetër që hapet ose rifreskohet.