API
###########

**Шановні користувачі!**

Ми активно працюємо над оновленням бази знань EDIN-WiKi, тому ця сторінка втратила актуальність.

Актуальну версію документації ви знайдете за новим `посиланням <https://wiki-v2.edin.ua/books/robota-z-api/chapter/api-servisu-tender>`__

Свої побажання, зауваження ви можете залишати в коментарях до статті на новій EDIN-WiKi.

Дякуємо за розуміння та користування сервісом!

.. сторінка перенесена на нову вікі

   .. hint::
    Всі запити нижче перерахованих API методів сервісу EDIN-Tender 2.0 направляються на адресу: https://edo-v2.edin.ua 

   Авторизація
   ==============

   +-----------+-----------------------------+---------------------------------------------------------------------------------------------------+
   | **Метод** |       **URL запиту**        |                                             **Опис**                                              |
   +===========+=============================+===================================================================================================+
   | POST      | ``/api/authorization/hash`` | `Авторизація <https://wiki.edin.ua/uk/latest/API_Tender/Methods/Authorization.html>`__            |
   +-----------+-----------------------------+---------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/Authorization
   Methods/AuthCheck

   Робота зі ставками
   ============================

   +-----------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
   | **Метод** |       **URL запиту**        |                                                       **Опис**                                                        |
   +===========+=============================+=======================================================================================================================+
   | POST      | ``/api/v1/tender/lot/bets`` | `Зробити ставку по лоту (Учасник) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/AddBets.html>`__                 |
   +-----------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+
   | DELETE    | ``/api/v1/tender/lot/bets`` | `Видалити ставку по лоту тендера (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/DeleteBets.html>`__ |
   +-----------+-----------------------------+-----------------------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/AddBets
   Methods/DeleteBets

   Робота з тендерами
   ============================

   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | **Метод** |                   **URL запиту**                   |                                                                   **Опис**                                                                   |
   +===========+====================================================+==============================================================================================================================================+
   | POST      | ``/api/v1/tender/auctions``                        | `Створити новий тендер (чернетку) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/CreateAuction.html>`__                                  |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | PATCH     | ``/api/v1/tender/auctions/publish``                | `Опублікувати тендер <https://wiki.edin.ua/uk/latest/API_Tender/Methods/PublishAuction.html>`__                                              |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auction``                         | `Отримати дані тендера (за id) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetSingle.html>`__                                         |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auctions/drafts``                 | `Отримання списку тендерів з "Чернеток" <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetDraftsList.html>`__                            |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auctions/my``                     | `Отримання списку тендерів з "Мої тендери" <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetMyList.html>`__                             |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auctions/all``                    | `Отримання списку з "Усі тендери" <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetAllList.html>`__                                     |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auction/views``                   | `Отримати дані про перегляди тендера (за id) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetAuctionViews.html>`__                     |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/guest/auctions/all``              | `Отримання списку тендерів для неавторизованого користувача <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetAllListGuest.html>`__      |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | PATCH     | ``/api/v1/tender/auctions/close``                  | `Завершити тендер (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/CloseAuction.html>`__                                     |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | POST      | ``/api/v1/tender/auction/access/invite``           | `Запросити компанії взяти участь в тендері (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/InvitePartners.html>`__          |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | POST      | ``/api/v1/tender/auction/access/request``          | `Подати заявку на участь в закритому аукціоні (Учасник) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/AccessRequest.html>`__            |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/auction/access/company/outgoing`` | `Отримати дані по заявкам на участь в закритих аукціонах (Учасник) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/ListByCompany.html>`__ |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | PATCH     | ``/api/v1/tender/auction/access/confirm``          | `Схвалити заявку на участь в закритому аукціоні (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/AccessConfirm.html>`__      |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
   | PATCH     | ``/api/v1/tender/auction/access/reject``           | `Відхилити заявку на участь в закритому аукціоні (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/AccessReject.html>`__      |
   +-----------+----------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/CreateAuction
   Methods/PublishAuction
   Methods/GetSingle
   Methods/GetDraftsList
   Methods/GetMyList
   Methods/GetAllList
   Methods/GetAuctionViews
   Methods/GetAllListGuest
   Methods/CloseAuction
   Methods/InvitePartners
   Methods/AccessRequest
   Methods/ListByCompany
   Methods/AccessConfirm
   Methods/AccessReject

   Вкладення
   ============================

   +-----------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | **Метод** |         **URL запиту**         |                                                                               **Опис**                                                                                |
   +===========+================================+=======================================================================================================================================================================+
   | POST      | ``/api/v1/tender/attachments`` | `Додати вкладення до тендера, лота (Організатор) / Додати вкладення до ставки (Учасник) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/CreateAttachments.html>`__ |
   +-----------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/attachments`` | `Отримати список вкладень до тендера/лота/ставки <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetListAttachments.html>`__                                       |
   +-----------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/attachment``  | `Отримати файл-вкладення до тендера/лота/ставки <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetFileAttachments.html>`__                                        |
   +-----------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | DELETE    | ``/api/v1/tender/attachment``  | `Видалити вкладення до тендера / лота (Організатор) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/DeleteAttachments.html>`__                                     |
   +-----------+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/CreateAttachments
   Methods/GetListAttachments
   Methods/GetFileAttachments
   Methods/DeleteAttachments

   Робота з підписками
   ============================

   +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
   | **Метод** |           **URL запиту**           |                                                                         **Опис**                                                                          |
   +===========+====================================+===========================================================================================================================================================+
   | GET       | ``/api/v1/tender/user/subscribes`` | `Отримати список користувачів, на яких підписаний поточний Адміністратор акаунта <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetSubscribe.html>`__ |
   +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
   | POST      | ``/api/v1/tender/user/subscribes`` | `Додати підписку на користувача (Адміністратор акаунта) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/PostSubscribe.html>`__                         |
   +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
   | DELETE    | ``/api/v1/tender/user/subscribes`` | `Видалити підписку на користувача (Адміністратор акаунта) <https://wiki.edin.ua/uk/latest/API_Tender/Methods/DelSubscribe.html>`__                        |
   +-----------+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/GetSubscribe
   Methods/PostSubscribe
   Methods/DelSubscribe

   Довідники
   ============================

   +-----------+-------------------------------+--------------------------------------------------------------------------------------------------------+
   | **Метод** |        **URL запиту**         |                                                **Опис**                                                |
   +===========+===============================+========================================================================================================+
   | GET       | ``/api/v1/tender/categories`` | `Отримати довідник категорій <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetCategories.html>`__ |
   +-----------+-------------------------------+--------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/currency``   | `Отримати довідник валют <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetCurrency.html>`__       |
   +-----------+-------------------------------+--------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/regions``    | `Отримати довідник регіонів <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetRegions.html>`__     |
   +-----------+-------------------------------+--------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/units``      | `Отримати довідник одиниць виміру <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetUnits.html>`__ |
   +-----------+-------------------------------+--------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/GetCategories
   Methods/GetCurrency
   Methods/GetRegions
   Methods/GetUnits

   Довідник учасників
   ============================

   +-----------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
   | **Метод** |              **URL запиту**               |                                                            **Опис**                                                             |
   +===========+===========================================+=================================================================================================================================+
   | GET       | ``/api/v1/tender/participant_group/list`` | `Отримати список всіх наявних груп учасників <https://wiki.edin.ua/uk/latest/API_Tender/Methods/ParticipantGroups.html>`__      |
   +-----------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
   | GET       | ``/api/v1/tender/participant_group``      | `Отримати дані групи учасників <https://wiki.edin.ua/uk/latest/API_Tender/Methods/GetParticipantGroupController.html>`__        |
   +-----------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
   | POST      | ``/api/v1/tender/participant_group``      | `Створити/Редагувати групу учасників <https://wiki.edin.ua/uk/latest/API_Tender/Methods/PostParticipantGroupController.html>`__ |
   +-----------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
   | DELETE    | ``/api/v1/tender/participant_group``      | `Видалити групу учасників <https://wiki.edin.ua/uk/latest/API_Tender/Methods/DelParticipantGroupController.html>`__             |
   +-----------+-------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+

   .. beauty list

   .. toctree::
   :hidden:
   :glob:

   Methods/ParticipantGroups
   Methods/GetParticipantGroupController
   Methods/PostParticipantGroupController
   Methods/DelParticipantGroupController

   ---------------------------------

   .. _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

.. old auto list (deprecated)

    .. toctree::
    :hidden:
    :glob:

    Methods/*

------------------

.. include:: /_constant/kontakti.rst