API бүт кластерди камтыйт

Интерфейстеги ар кандай операция сырттан жеткиликтүү: справочниктер, калдыктар, документтер, өндүрүш тапшырмалары, пландаштыруу эсептөөлөрү жана отчёттор.

Келишимдин принциптери

  • Контроллерлор боюнча ыкмалар

    Ыкманын дареги бөлүм менен аракеттен турат: StockDocuments/PostDocument. Бузуучу өзгөртүү жаңы версия менен чыгат, мурункусу бүт өтүү мезгилинде иштейт.

  • Жазуунун идемпотенттүүлүгү

    Жазуу операциялары аталышта идемпотенттүүлүк ачкычын кабыл алат. Ошол эле суроону кайра жөнөтүү документти эки жолу өткөрбөйт.

  • Бардык жерде пагинация

    Тизме ыкмалары offset, count, чыпкаларды жана сорттоону кабыл алат. Жоопто элементтер жана жалпы саны болот.

  • Бир суроого бир уюм

    Ар бир суроо уюмдун жана A3.ID сессиясынын контекстинде аткарылат. Системада уюм боюнча чыпкасыз суроо жок.

Ыкмалардын негизги топтору

  • GETItems/GetItemsТоптору, өлчөө бирдиктери жана эсеп белгилери менен номенклатура
  • GETStock/GetBalancesӨлчөмдөр боюнча калдыктар, белгилүү күнгө абалды кошо
  • GETStock/GetMovementsНегиз документи жана сторного шилтемеси бар кыймылдар
  • POSTStockDocuments/CreateDocumentОн үч түрдүн каалаганы боюнча кампа документин түзүү
  • PUTStockDocuments/PostDocumentДокументти өткөрүү жана кыймылдарды жазуу
  • POSTReservations/CreateReservationБулагы жана жарактуу мөөнөтү бар резерв
  • GETProductionOrders/GetProductionOrdersАбалы, камсыздоосу жана чыгаруусу менен өндүрүш тапшырмалары
  • POSTPlanning/RunPlanningМуктаждыкты эсептөөнү фондук тапшырма катары баштоо

Жооптун мисалы

Калдык эсептин бардык өлчөмдөрү боюнча дароо кайтарылат: кампа, уяча, партия жана мүнөздөмө. 1-режимде өлчөмдөр кызматтык демейки маанилер менен келет.

GET Stock/GetBalances?itemId=7f31a0

{
  "items": [
    {
      "warehouseId": "main",
      "cellId": "A-04-12",
      "batchId": "2026-07-14",
      "quantity": 1840.5,
      "reserved": 320,
      "available": 1520.5,
      "averageCost": 412.37,
      "currency": "KZT"
    }
  ],
  "totalCount": 1
}

Вебхуктар

Жазылуу уюм деңгээлинде жөндөлөт, ар бир билдирүү купуя ачкыч менен кол коюлат. Жеткирүү ырасталганга чейин кайталанат, чыгуучу окуялар журналда кол менен кайталоо мүмкүнчүлүгү менен көрүнөт.

  • StockDocumentPostedКампа документи өткөрүлдү
  • StockBalanceChangedКалдык өзгөрдү
  • MinimumStockReachedЭң аз калдыкка жетти
  • ProductionOrderStatusChangedӨндүрүш тапшырмасынын абалы өзгөрдү
  • ProductionOutputRegisteredЧыгаруу катталды
  • ProductionOrderClosedӨндүрүш тапшырмасы жабылды
  • PlanningRunCompletedПландаштыруу эсеби аяктады
  • MaintenanceRequestStatusChangedОңдоого өтүнмөнүн абалы өзгөрдү
  • EquipmentAvailabilityChangedЖабдуунун жеткиликтүүлүгү өзгөрдү

Документация ачык

Ыкмалардын сүрөттөмөсү, моделдердин схемалары жана суроолордун мисалдары API документациясында ачык. Кирүү A3.ID же уюмдун API ачкычы аркылуу, жыштык чектөөсү уюм деңгээлинде иштейт.