/
UpdateCompanyFromSign.rst
135 lines (110 loc) · 7.43 KB
/
UpdateCompanyFromSign.rst
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
########################################
**Оновлення компанії з КЕП/ЕЦП**
########################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/uk/latest/API_DOCflow/Methods/Authorization.html>`__ .
.. attention:: Оновлення компанії з КЕП/ЕЦП відбувається в два кроки:
1) Користувачу необхідно отримати унікальний UUID (метод **{url сервера}/bdoc/sign_auth_uuid**). Далі отриманий UUID необхідно підписати ЕЦП - зовнішнє підписання, в результаті якого користувач отримує **.bin**-файл.
2) Користувачу необхідно відправити отриманий **.bin**-файл (пункт 1), використовуючи метод **{url сервера}/bdoc/company/approve**.
**Отримання UUID (крок 1)**
===================================
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP GET** |
+==============================================================+============================================================================================================+
| **Content-Type** | application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edi-n.com/bdoc/sign_auth_uuid** |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
В результаті успішного запиту отримуємо у **відповідь** "UUID" у вигляді рядка. UUID необхідно підписати ЕЦП, в результаті підписання якого користувач отримує **.bin**-файл.
--------------
**Оновлення компанії (крок 2)**
===================================
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP POST** |
+==============================================================+============================================================================================================+
| **Content-Type** | application/binary/json (тіло запиту передається в бінарному вигляді, тіло відповіді в json форматі) |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **URL запиту** | **https://doc.edi-n.com/bdoc/company/approve** |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | В рядку заголовка (Header) "Set-Cookie" обов'язково передається **SID** - токен, отриманий при авторизації |
| | |
| | **Обов'язкові url-параметри:** |
| | |
| | **company_id** - ID компанії |
+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
**Параметри HTTP запиту/відповіді**
***********************************************************
``REQUEST``
В тілі **запиту** передається **.bin**-файл (підписаний UUID).
``RESPONSE``
Опис json-параметрів **відповіді** метода API (об'єкт **Company**)
Таблиця 1 - Опис параметрів об'єкта **Company**
.. csv-table::
:file: for_csv/Company.csv
:widths: 1, 12, 41
:header-rows: 1
:stub-columns: 0
**Приклади**
*********************************
В тілі **запиту** передається **.bin**-файл (підписаний UUID).
--------------
Приклад тіла **відповіді** (json):
.. code:: ruby
{
"companyId": 1329,
"accountId": 8,
"type": 1,
"name": "Название",
"inn": "144444444444",
"code": "12345",
"isApproved": 0,
"isSignedOffer": 1,
"isActive": 1,
"ownershipType": "Форма собственности",
"atCode": "КОАТУУ",
"certNum": "Номер свидетельства",
"uuid": "8af7a3e0-297a-4463-a353-b229137aaba8",
"bankAcc": {},
"legalAddress": {
"localityType": 0
},
"actualAddress": {
"localityType": 0
},
"fizName": {},
"certificates": [],
"dictionaries": [],
"notifySettings": [
{
"notifyType": 1,
"notifyStatus": 2,
"emails": []
},
{
"notifyType": 2,
"notifyStatus": 2,
"emails": []
},
{
"notifyType": 3,
"notifyStatus": 2,
"emails": []
},
{
"notifyType": 4,
"notifyStatus": 2,
"emails": []
},
{
"notifyType": 5,
"notifyStatus": 2,
"emails": []
},
{
"notifyType": 6,
"notifyStatus": 2,
"emails": []
}
]
}