Skip to content

Commit

Permalink
Merge pull request #7 from EDI-N/Kolya
Browse files Browse the repository at this point in the history 
api-api
  • Loading branch information
@EDI-N
EDI-N committed Jun 6, 2019
2 parents 5cf4fe6 + 0f10f7a commit 85df3a3
Show file tree
Hide file tree
Showing 7 changed files with 229 additions and 229 deletions.
60 changes: 30 additions & 30 deletions docs/integration_2_0/API/EdsChain.rst
View file

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions docs/integration_2_0/API/EdsDoc.rst
View file

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions docs/integration_2_0/API/OasIdentifiers.rst
View file
Original file line number Diff line number Diff line change
@@ -1,76 +1,76 @@
######################################################################
**Получение информации об организации по Названию/ИНН/КПП/GLN**
**Отримання інформації про організацію по Назві/ІПН/КПП/GLN**
######################################################################

Для работы с этим методом пользователь должен быть `авторизированным <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html>`__ .

Метод позволяет пользователю просматривать дополнительную информацию о других пользователях на уровне одного общего аккаунта.

+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **Метод запроса** | **HTTP GET** |
+=============================================================+=====================================================================================================================================+
| **Content-Type** | application/json (тело запроса/ответа в json формате в теле HTTP запроса |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **URL запроса** | https://edo-v2.edi-n.com/api/oas/identifiers |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **Параметры, передаваемые в URL (вместе с адресом метода)** | В строке заголовка (Header) "Set-Cookie" обязательно передается **SID** - токен полученный при авторизации |
| | **Обязательные url-параметры:** |
| | |
| | **gln** - строка(13); номер GLN организации, которая связана с авторизированным пользователем платформы EDIN 2.0 на уровне аккаунта |
| | |
| | **query** - строка; название/ИНН/КПП/GLN организации; "над которым осуществляется действие" |
| | |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+

.. hint:: Также возможно выполнить запрос в виде curl-строки:
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html>`__ .

Метод дозволяє користувачеві переглядати додаткову інформацію про інших користувачів на рівні одного загального аккаунта.

+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP GET** |
+==============================================================+=============================================================================================================================+
| **Content-Type** | application/json (тіло HTTP запиту / відповіді в json форматі) |
+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://edo-v2.edi-n.com/api/oas/identifiers |
+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | У рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен отриманий при авторизації |
| | **Обов'язкові url-параметри:** |
| | |
| | **gln** - рядок (13); номер GLN організації, яка пов'язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта |
| | |
| | **query** - рядок; назва/ІПН/КПП/GLN організації; "Над яким здійснюється дія" |
| | |
+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+

.. hint:: Також можливо виконати запит у вигляді curl-рядка:

curl -X GET 'https://edo-v2.edi-n.com/api/oas/identifiers?gln=9864065702429&query=EDS_1' -b 'SID=458a0d38-5b56-4b8e-8998-009a1edd31eb'

Спецификация для расшифровки ключей curl запроса: https://curl.haxx.se/docs/manpage.html
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

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

**JSON-параметры в теле HTTP запроса/ответа**
**JSON-параметри в тілі HTTP запиту/відповіді**

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

**REQUEST**

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

В этом методе json-тело **запроса** отсутствует (другие данные передавать не нужно).
У цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).

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

**RESPONSE**

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

Таблица 1 - Описание json-параметров, которые могут передаваться в **ответ** на метод API
Таблиця 1 - Опис json-параметрів, які можуть передаватися у **відповідь** на метод API

.. csv-table::
:file: for_csv/Identificator.csv
:widths: 1, 19, 41
:header-rows: 1
:stub-columns: 0

Таблица 2 - Описание параметров объекта **Account**)
Таблиця 2 - Опис параметрів об'єкта **Account**)

.. csv-table::
:file: for_csv/Account.csv
:widths: 1, 19, 41
:header-rows: 1
:stub-columns: 1

Таблица 3 - Описание параметров объекта **Company**)
Таблиця 3 - Опис параметрів об'єкта **Company**)

.. csv-table::
:file: for_csv/Company.csv
:widths: 1, 19, 41
:header-rows: 1
:stub-columns: 0

Таблица 4 - Описание параметров объекта **User**)
Таблиця 4 - Опис параметрів об'єкта **User**)

.. csv-table::
:file: for_csv/User.csv
Expand All @@ -80,15 +80,15 @@

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

**Примеры**
**Приклади**

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

**Запрос не содержит тела (json)**
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**

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

**Пример тела ответа (json):**
**Приклад тіла відповіді (json):**

.. code:: ruby
Expand Down
62 changes: 31 additions & 31 deletions docs/integration_2_0/API/OasRetailers.rst
View file
Original file line number Diff line number Diff line change
@@ -1,79 +1,79 @@
######################################################################
**Получение списка розничных сетей, которые связаны с заданным GLN**
**Отримання переліку роздрібних мереж, які пов'язані із заданим GLN**
######################################################################

Для работы с этим методом пользователь должен быть `авторизированным <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html>`__ .
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html>`__ .

С помощью метода **api/oas/retailers** можно получить список всех розничных сетей-контрагентов пользователя.
За допомогою методу **api/oas/retailers** можливо отримати перелік всіх роздрібних мереж-контрагентів користувача.

+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **Метод запроса** | **HTTP GET** |
| **Метод запиту** | **HTTP GET** |
+=============================================================+=====================================================================================================================================+
| **Content-Type** | application/json (тело запроса/ответа в json формате в теле HTTP запроса |
| **Content-Type** | application/json (тіло HTTP запиту / відповіді в json форматі) |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **URL запроса** | https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429 |
| **URL запиту** | https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429 |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| **Параметры, передаваемые в URL (вместе с адресом метода)** | В строке заголовка (Header) "Set-Cookie" обязательно передается **SID** - токен полученный при авторизации |
| **Параметри, що передаються в URL (разом з адресою методу)** | У рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен отриманий при авторизації |
| | |
| | **Обязательные url-параметры:** |
| | **Обов'язкові url-параметри:** |
| | |
| | **gln** - строка(13); номер GLN организации, которая связана с авторизированным пользователем платформы EDIN 2.0 на уровне аккаунта |
| | **gln** - рядок (13); номер GLN організації, яка пов'язана з авторизованим користувачем платформи EDIN 2.0 на рівні акаунта |
| | |
+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+

.. hint:: Также возможно выполнить запрос в виде curl-строки:
.. hint:: Також можливо виконати запит у вигляді curl-рядка:

curl -X GET 'https://edo-v2.edi-n.com/api/oas/retailers?gln=9864065702429' -b 'SID=458a0d38-5b56-4b8e-8998-009a1edd31eb'

Спецификация для расшифровки ключей curl запроса: https://curl.haxx.se/docs/manpage.html
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html

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

**JSON-параметры в теле HTTP запроса/ответа**
**JSON-параметри в тілі HTTP запиту/відповіді**

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

**REQUEST**

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

В этом методе json-тело **запроса** отсутствует (другие данные передавать не нужно).
У цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).

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

**RESPONSE**

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

**Ответ:** массив объектов данных о розничных сетях
**Відповідь:** масив об'єктів даних про роздрібні мережі

Таблица 4 - Описание json-параметров, которые могут передаваться в **ответ** на метод API
Таблиця 4 - Опис json-параметрів, які можуть передаватися у **відповідь** на метод API

+-----------+--------+-------------------------------------+
| Параметр | Формат | Описание |
+===========+========+=====================================+
| id | long | идентификатор розничной сети |
+-----------+--------+-------------------------------------+
| name | String | наименование розничной сети |
+-----------+--------+-------------------------------------+
| gln | String | GLN розничной сети |
+-----------+--------+-------------------------------------+
| aliasName | String | брендирование розничной сети |
+-----------+--------+-------------------------------------+
| type | String | тип/признак розничной сети (type=1) |
+-----------+--------+-------------------------------------+
+-----------+--------+---------------------------------------+
| Параметр | Формат | Опис |
+===========+========+=======================================+
| id | long | ідентифікатор роздрібної мережі |
+-----------+--------+---------------------------------------+
| name | String | найменування роздрібної мережі |
+-----------+--------+---------------------------------------+
| gln | String | GLN роздрібної мережі |
+-----------+--------+---------------------------------------+
| aliasName | String | брендування роздрібної мережі |
+-----------+--------+---------------------------------------+
| type | String | тип/ознака роздрібної мережі (type=1) |
+-----------+--------+---------------------------------------+

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

**Примеры**
**Приклади**

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

**Запрос не содержит тела (json)**
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**

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

**Пример тела ответа (json):**
**Приклад тіла відповіді (json):**

.. code:: ruby
Expand Down

0 comments on commit 85df3a3

Please sign in to comment.