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

Интерфейстің кез келген операциясы сырттан қолжетімді: анықтамалықтар, қалдықтар, құжаттар, өндірістік тапсырмалар, жоспарлау есептеулері және есептер.

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 кілті арқылы кіру, жиілікті шектеу ұйым деңгейінде жұмыс істейді.