חזרה למערכת
DEVELOPMENT API · OPENAPI 3.1

API וכלי פיתוח

תיעוד הנתיבים שכבר ממומשים, מודלים וכלי TypeScript. המערכת כוללת חשבונות אישיים ו־sessions, לצד כניסת הפיתוח הפרטית ללא סיסמה שנשמרה לבקשת הבעלים. זו אינה עדיין פריסה ציבורית.

מה כלול ומה לא

הנתיבים נבדקים מול ה־router ב־Go. חלק ממבני התוצאות המשתנים של דוחות, ייבוא ואודיט עדיין מתוארים באופן חלקי. אין כאן endpoint מומצא לשליחת Webhooks או שיתוף ציבורי. קישורי אימות ושחזור חשבון דורשים הגדרת שירות דואר אמיתית; לא נטען שנשלח מייל ללא הגדרה. תזמוני הדוחות מפיקים לתיבה פרטית במערכת.

OpenAPI JSONSDK, טיפוסים ודוגמאותהוראות SDKכלי גיבוי ושחזור למפעיל

דוגמת שימוש לקריאה בלבד

import { TimerClient } from './sdk/index.js';
const api = new TimerClient(location.origin);
const prepared = api.prepare('getV1Workspaces', {});
const result = await api.execute(prepared);
console.log(result.items);

לפני כתיבה יש לשמור את הבקשה המוכנה באחסון עמיד ולשמור את אישור השרת לפני מחיקתה. אין ליצור מפתח חדש רק כי תשובה אבדה. שגיאת 412 דורשת קריאה ובדיקה מחדש, לא דריסה עם גרסה חדשה.