API техникалық бөлшек емес, өнім функциясы

Ашық REST бас тартылған ортақ тапсырма қозғалтқышын алмастырады. Оған қосылу қаншалықты арзан болса, өнімдер арқылы өтетін ортақ жұмыс тізімі соншалықты шынайы болады.

Келісімге не салынған

Жол бойынша нұсқалау

Барлық контроллер /api/v1 астында тұрады. Бұзатын өзгеріс өтпелі кезеңде алдыңғы нұсқаның қолдауын талап етеді, ескі жолдар екі шығарылым бойы алиас болып қалады.

Жазудың идемпоттылығы

Жазу операциялары идемпоттылық кілтін қабылдайды. Желі үзілгендегі қайталанған шақыру екіншісін құрмай, жазбаны жаңартады. Мұндай интеграциялардағы ең жиі қате осы.

Құқықтар интерфейстегідей

A3.ID арқылы аутентификация, қатынау тексерулері интерфейстегімен бірдей. Сыртқы қатысушыға экономикалық өрістер клиентте жасырылмайды, мүлде берілмейді.

Экожүйе үшін бөлек лимит

Интеграциялық трафик табиғаты бойынша шыңды, клиенттік трафик біркелкі. Екеуіне бір лимит қою не интеграцияларды тұншықтырар, не теріс пайдаланудан қорғамас еді.

Әдістер топтары

  • GET/api/v1/tasksБеттеуі, сүзгілері және сұрыптауы бар тапсырмалар тізімі
  • POST/api/v1/tasksТапсырма құру, мәртебе ауыстыру, тағайындау, топтық операциялар
  • POST/api/v1/assignmentsИдемпоттылық кілті бар сыртқы тапсырма
  • PUT/api/v1/assignments/{key}Сыртқы кілт бойынша жаңарту және жабу
  • GET/api/v1/projectsЖобалар, қатысушылар, бақылау нүктелері және бюджет
  • POST/api/v1/time-entriesУақыт жазу, оқу және бекіту
  • GET/api/v1/views/overdueДайын кесінділер: менің тапсырмаларым, мерзімі өткендер, жоба бойынша
  • POST/api/v1/exportШақырушының құқығымен ұйым деректерін шығару

Сыртқы тапсырма

Өнім-дереккөз өз мәнін және оған сілтемені береді. Сол externalKey-мен қайталанған шақыру екіншісін құрмай, тапсырманы жаңартады.

POST /api/v1/assignments

{
  "externalKey": "legal-case-8421",
  "sourceProduct": "lawyer",
  "sourceEntityType": "LegalCase",
  "sourceEntityId": "8421",
  "deepLink": "https://app.lawyer.a3.solutions/cases/8421",
  "title": "Подготовить исковое заявление",
  "assigneeId": "u-2f9c",
  "dueDate": "2026-10-02"
}

Вебхуктар

Өнім-дереккөз A3.Projects-ті кесте бойынша сұрамауы үшін оқиғаларға жазылу.

task.createdТапсырма интерфейсте немесе API арқылы құрылды
task.status_changedТапсырма күйін ауыстырды, пысықтауға қайтаруды қоса
task.closedТапсырма аяқталды немесе себебі көрсетіліп тоқтатылды
time_entry.loggedУақыт жазылды, кіріктірілген виджет арқылы да
project.status_changedЖоба тоқтатылды, аяқталды немесе болдырылмады
budget.threshold_reachedБюджет шегіне жетті, әр шекке бір рет іске қосылады

Жеке қатынау токендері

Токен нақты интеграцияға құрылады және иесінің құқығынан кең емес айқын тізіммен шектеледі. Базада тек хеш сақталады, жарамдылық мерзімі 180 күннен аспайды.

  • Аймақтар толықтай емес, айқын тізіммен шектелген
  • Базада тек SHA-256, токенді қайта көрсету мүмкін емес
  • Жарамдылық мерзімі 180 күннен аспайды, ұзарту жаңа токенді талап етеді
  • Токендер токеннің өзімен емес, сеанс арқылы басқарылады

ИИ агентіне қатынау

Сол ашық API экожүйе агентіне MCP арқылы кіру нүктесі болады. Агент пайдаланушының атынан және сол қатынау тексерулерімен жұмыс істейді.

Құқық бойынша бас тарту бос тізім емес, құрал қатесі болып қайтады. Әйтпесе агент тапсырмалар жай ғана көрінбейтін жерде «сізде тапсырма жоқ» дер еді.

Келісім ашық

Схема, сұраныс мысалдары және қате кодтары жарияланған. Құм жәшігі алғашқы эталондық интеграциядан кейін пайда болады: бірінші тұтынушысыз ол ойдан шығарылған сценарийге қызмет етер еді.