🚛 API "ETTN" v3 #################### Шановні користувачі! Ми активно працюємо над оновленням бази знань EDIN-WiKi, тому ця сторінка втратила актуальність. Актуальну версію документації ви знайдете за новим `посиланням `__ Свої побажання, зауваження ви можете залишати в коментарях до статті на новій EDIN-WiKi. Дякуємо за розуміння та користування сервісом! .. сторінка перенесена на нову вікі .. image:: Work_with_API/pics/Main_API_002.png :align: center :height: 700px :alt: Стандартна схема документообігу Алгоритми обміну документами (API) ==================================== .. toctree:: :maxdepth: 1 Work_with_API/ETTNv3_API_work Additional_transactions .. toctree:: :maxdepth: 1 Work_with_API/Proposalv3_API_work .. toctree:: :maxdepth: 1 Work_with_API/DisagreementActv3_API_work Work_with_API/LoadRejectActv3_API_work Work_with_API/StopActv3_API_work Work_with_API/ResealingActv3_API_work Work_with_API/StorageDeliveryActv3_API_work Work_with_API/StoragePickUpActv3_API_work Work_with_API/ReloadActv3_API_work Work_with_API/ConsigneeChangeActv3_API_work Work_with_API/AdjustmentActv3_API_work .. toctree:: :maxdepth: 1 Work_with_API/COMDOC_040_API_work Work_with_API/COMDOC_037_API_work ------------------------------- .. hint:: Всі запити нижче перерахованих API методів сервісу "ЕТТН" направляються на адресу: https://edo-v2.edin.ua Авторизація ============== +-----------+-----------------------------+---------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+=============================+===================================================================================================+ | POST | ``/api/authorization/hash`` | `Авторизація `__ | +-----------+-----------------------------+---------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: /integration_2_0/APIv2/Methods/Authorization /integration_2_0/APIv2/Methods/AuthCheck .. _general: Загальні методи сервісу "ЕТТН" ============================================================= +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+====================================+===========================================================================================================================================================================+ | GET | ``/api/eds/doc/ettn/body`` | `Отримання (завантаження) тіла документа сервісу "ЕТТН" в JSON/XML/ECMR/PDF/ZIP форматі `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/sign`` | `Підписання даних сервісу "ЕТТН" (збереження підпису) `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/eds/doc/tickets`` | `Отримання всіх квитанцій вказаного документа `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/eds/doc`` | `Отримання інформації (мета-даних) про документ `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/eds/doc/ettn/sign/info`` | `Отримання інформації про підписантів е-ТТН та Актів v3 (family=7) `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/eds/docs`` | `Видалити документи-чернетки `__ | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/oas/v2/transport`` | :doc:`/API_ETTNv3_1/Methods/GetTransport` | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/oas/v2/transport`` | :doc:`/API_ETTNv3_1/Methods/PostTransport` | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | DELETE | ``/api/eds/doc/ettn/draft_ticket`` | :doc:`/API_ETTNv3_1/Methods/DeleteDraftTicket` | +-----------+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/GetEcmrDocumentBody Methods/SaveEcmrSign /integration_2_0/APIv2/Methods/GetTickets /integration_2_0/APIv2/Methods/GetDocument Methods/GetEttnSignInfo /integration_2_0/APIv2/Methods/DeleteDocuments Methods/GetTransport Methods/PostTransport Methods/DeleteDraftTicket .. _ecmr-ttn: Робота з "Електронною товарно-транспортною накладною" (е-ТТН) ========================================================================================= +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+===========================================+===================================================================================================================================================================+ | POST | ``/api/eds/doc/ettn/ttn`` | `Створення/редагування чернетки "Електронної товарно-транспортної накладної" (е-ТТН) `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/eds/doc/ettn/ttn/send`` | `Відправка електронної товарно-транспортної накладної ("е-ТТН") з Чернеток `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/ttn/transaction`` | `Створення/редагування нової транзакції (чернетки) до е-ТТН документа `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/eds/doc/ettn/ttn/transaction`` | `Відправка нової транзакції до е-ТТН документа `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/eds/doc/ettn/ttn/reject`` | `Відхилення "Електронної товарно-транспортної накладної" (е-ТТН) `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/ttn/attachment`` | `Додавання до документа вкладення (pdf) до документа е-ТТН `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/eds/doc/ettn/ttn/attachment`` | `Отримання (завантаження) файлу-вкладення до документа е-ТТН `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/eds/doc/ettn/ttn/attachment`` | `Відправки вкладення на повторну реєстрацію (при виникненні помилки) `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | DELETE | ``/api/eds/doc/ettn/ttn/attachment`` | `Видалення файлу-вкладення до документа е-ТТН `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/ttn/create_and_send`` | `Створення та відправка "е-ТТН" документа (без створення чернетки) `__ | +-----------+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/CreateEcmrEttn Methods/SendEcmrDoc Methods/PostEcmrTransaction Methods/PutEcmrTransaction Methods/RejectEcmr Methods/PostEcmrAttachment Methods/GetEcmrAttachment Methods/PatchEcmrAttachment Methods/DeleteEcmrAttachment Methods/CreateAndSendTtn .. _ecmr-act: Робота з актами ("Акт перевантаження", "Акт коригування", ...) до е-ТТН ========================================================================================= +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+========================================+==============================================================================================================================================================================+ | POST | ``/api/eds/doc/ettn/adjustment`` | `Створення/редагування чернетки "Акта коригування" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/consignee_change`` | `Створення/редагування чернетки "Акта про заміну пункту призначення вантажу" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/disagreement`` | `Створення/редагування чернетки "Акта розбіжностей про вантаж" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/load_reject`` | `Створення/редагування чернетки "Акта про відмову вантажити" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/reload`` | `Створення/редагування чернетки "Акта перевантаження" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/resealing`` | `Створення/редагування чернетки "Акта перепломбування" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/stop`` | `Створення/редагування чернетки "Акта примусового завершення е-ТТН" `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/storage_delivery`` | `Створення/редагування чернетки "Акта розвантаження на проміжному складі" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/storage_pickup`` | `Створення/редагування чернетки "Акта завантаження на проміжному складі" до е-ТТН `__ | +-----------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+=======================================+======================================================================================================================================================+ | POST | ``/api/eds/doc/ettn/act/transaction`` | `Створення/редагування нової транзакції (чернетки) до Актів сервісу `__ | +-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/eds/doc/ettn/act/transaction`` | `Відправка нової транзакції до Актів сервісу `__ | +-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | PUT | ``/api/eds/doc/ettn/act/reject`` | `Відхилення Актів сервісу `__ | +-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | PATCH | ``/api/eds/doc/ettn/act/send`` | `Відправка Актів з Чернеток `__ | +-----------+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/CreateAdjustmentAct Methods/CreateConsigneeChangeAct Methods/CreateDisagreementAct Methods/CreateLoadRejectAct Methods/CreateReloadAct Methods/CreateResealingAct Methods/CreateStopAct Methods/CreateStorageDeliveryAct Methods/CreateStoragePickUpAct Methods/PostActTransaction Methods/PutActTransaction Methods/RejectAct Methods/SendAct .. _subscribe: Підписки на події ========================================================================================= +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+=============================+================================================================================================================================================================+ | GET | ``/api/mintrans/subscribe`` | `Отримання даних про підписки на події / Отримання даних про підпис особи `__ | +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/mintrans/subscribe`` | `Створення (оформлення) підписки на події (отримання документів) `__ | +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | DELETE | ``/api/mintrans/subscribe`` | `Видалення підписки на події (отримання документів) `__ | +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/mintrans/events`` | `Отримання списку подій з ЦБД `__ | +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | GET | ``/api/mintrans/doc`` | `Отримання документа з ЦБД `__ | +-----------+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/GetSubscribeController Methods/PostSubscribeController Methods/DeleteSubscribeController Methods/MintransEvents Methods/GetMintransDoc .. _consolidated-ttn: Робота зі «Зведеною ТТН» ========================================================================================= +-----------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | **Метод** | **URL запиту** | **Опис** | +===========+=====================================+===================================================================================================================================+ | GET | ``/api/eds/doc/ettn/ttn/link_docs`` | `Отримання пов'язаних документів «Зведеної ТТН» `__ | +-----------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | POST | ``/api/eds/doc/ettn/ttn/link_docs`` | `Прив'язка (додавання) ТТН до "Зведеної ТТН" `__ | +-----------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | DELETE | ``/api/eds/doc/ettn/ttn/link_docs`` | `Розірвання прив'язки (видалення) ТТН до "Зведеної ТТН" `__ | +-----------+-------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ .. beauty list .. toctree:: :hidden: :glob: Methods/GetLinkDocs Methods/PostLinkDocs Methods/DelLinkDocs --------------------------------- .. _ttn-errors: Опис помилок сервісу "ЕТТН" v3 ========================================================================================= .. csv-table:: :file: new_ttn_errors.csv :widths: 10, 20, 20, 40 :stub-columns: 0 Помилки, що можуть виникнути на стороні ЦБД: .. csv-table:: :file: mintrans_errors.csv :widths: 10, 40, 40 :stub-columns: 0 --------------------------------- .. _main-errors: Загальні помилки при роботі з API (всі сервіси EDIN) ========================================================================================= .. csv-table:: :file: /_constant/common_api_errors.csv :widths: 10, 20, 20, 40 :stub-columns: 0 .. csv-table:: :file: /_constant/main_api_errors.csv :widths: 10, 20, 60 :stub-columns: 0