Jegyek létrehozása más rendszerekből a Todomator API-val

Todomator · todomator@1.7 todomatorapitokenticketsintegration

A Todomator a műveleteit egyetlen API végponton keresztül teszi elérhetővé: POST /api/ JSON törzzsel { "schema": "<name>", "data": { ... } } (a Total.js API útvonalai; lásd a API útvonalak receptet). Az /api/ cím a config fájl $api sorából jön.

Hitelesítés tokennel

A bejelentkezett személy munkamenete mellett az API elfogad egy tokent: küldd az x-token fejlécben vagy a token lekérdezési paraméterben. Ha megegyezik a token beállítással (lásd beállítások), a kérés egy Bot nevű beépített felhasználóként fut, amely bot jogosultságú adminisztrátor; bármely más tokent elutasít. Használj hosszú véletlen tokent, tartsd a szervereden, és csak HTTPS-en küldd.

Jegy létrehozása

A hívás neve tickets_create. Csak a name kötelező; a többi opcionális:

Mező	Megjegyzések
`name`	a cím
`folder` vagy `folderid`	a mappa név szerint (a Todomator megkeresi) vagy azonosító szerint; a jegy átveszi a mappa számlázható jelzőjét
`users`	a hozzárendelendő személyek név vagy e-mail szerint; az ismeretlen személy hiba (`User "..." not found`)
`watcherid`	a követő személyek azonosító szerint (a `users` mezővel ellentétben ennek a verziónak a sémája név szerint nem fogadja el őket)
`statusid`	`pending` (alapértelmezett), `open`, `review`, `postponed`, `note` vagy `closed`
`markdown`, `html`	a tartalom
`tags`, `ispriority`, `isbillable`, `ispublic`	címkék és jelzők
`date`, `deadline`, `worked`	a nap, egy határidő és a már ledolgozott percek
`attachments`	`{ name, data }` elemek listája, ahol a `data` a fájl Base64-ben
`reference`, `source`, `attrs`	szabad mezők a jegy és a te rendszered összekapcsolásához
`callback`	egy cím, amely megkapja a jegyet

{
	"schema": "tickets_create",
	"data": {
		"name": "The invoice page fails with a 500",
		"folder": "Customer support",
		"users": ["jane@example.com"],
		"markdown": "Reported by the contact form.\n\nSteps: open the invoice and click *Print*.",
		"tags": ["bug"],
		"source": "website",
		"reference": "form-2041"
	}
}

A válasz az új jegy azonosítója. A hozzárendelt személyek értesítést kapnak, és frissülnek azoknak a nyitott munkamenetei, akik láthatják.

A callback

Ha a callback be van állítva, a Todomator POST kérést küld arra a címre a jegy adataival, amikor a jegyet létrehozzák, frissítik vagy klónozzák, és amikor megjegyzést adnak hozzá (létrehozáskor és frissítéskor a megadott mezők listáját is elküldi, keys). A rendszered ezzel tükrözheti a jegy állapotát.

További hívások

Ugyanez a végpont szolgálja ki a többi műveletet a controllers/api.js neveivel: tickets (lista), tickets_detail/{id}, tickets_update/{id}, tickets_clone/{id}, tickets_remove/{id}, logwork_create, folders, tags és továbbiak. A hivatalos API-dokumentáció a docs.totaljs.com/todomator címen található.