-
Notifications
You must be signed in to change notification settings - Fork 0
/
OasUser.rst
151 lines (115 loc) · 5.54 KB
/
OasUser.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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
######################################################################
**Отримання інформації по авторизованому користувачеві**
######################################################################
Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edi-n.com/ru/latest/integration_2_0/API/Authorization.html>`__ .
За допомогою метода **api/oas/user** можливо отримати інформацію про користувача, наприклад ID користувача, ID аккаунта, логін, чи має користувач "права адміністратора" (true / false), дані про платформу і інші ідентифікатори.
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| **Метод запиту** | **HTTP GET** |
+==============================================================+=======================================================================================================+
| **Content-Type** | application/json (тіло HTTP запиту / відповіді в json форматі) |
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| **URL запиту** | https://edo-v2.edi-n.com/api/oas/user |
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| **Параметри, що передаються в URL (разом з адресою методу)** | У рядку заголовка (Header) "Cookie" обов'язково передається **SID** - токен отриманий при авторизації |
+--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. hint:: Також можливо виконати запит у вигляді curl-рядка:
curl -X GET 'https://edo-v2.edi-n.com/api/oas/user' -b 'SID=65daca25-74ba-4c85-8183-71b404a348c0;'
Специфікація для розшифровки ключів curl запиту: https://curl.haxx.se/docs/manpage.html
--------------
**JSON-параметри в тілі HTTP запиту/відповіді**
--------------
**REQUEST**
--------------
У цьому методі json-тіло **запиту** відсутнє (інші дані передавати не потрібно).
--------------
**RESPONSE**
--------------
Таблиця 4 - Опис json-параметрів, які можуть передаватися у **відповідь** на метод API
.. csv-table::
:file: for_csv/User.csv
:widths: 1, 19, 41
:header-rows: 1
:stub-columns: 1
--------------
**Приклади**
--------------
**При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)**
--------------
**Приклад тіла відповіді (json):**
.. code:: ruby
{
"id": 5020571,
"accountId": 29824,
"login": "uaEDSsender",
"stringEmails": "test@qw.we",
"emails": [
"test@qw.we"
],
"blocked": 0,
"allowFTP": 1,
"autoSending": true,
"statusFile": 1,
"isAdmin": false,
"account": {
"platform": "EVO",
"id": 29824,
"name": "Test_EDS1",
"ownership": "#",
"inn": "1010101010",
"kpp": "100000001",
"mail": "test@qw.we",
"phone": "12345678901",
"ndsNumber": "#",
"bankAccount": "#",
"bankName": "#",
"bankMfo": "#",
"bankAddress": "#",
"identificators": [
],
"companies": [
],
"users": [
]
},
"identificators": [
{
"guid": {
},
"manager": "#",
"id": 133187,
"gln": "9864065702429",
"companyId": 29824,
"retailerId": 0,
"name": "EDS_1",
"companyType": "jur",
"companyInn": "1010101010",
"companyKpp": "90000031",
"zip": "112233",
"city": "г. Львов",
"street": "ул. Хмурится, 6",
"phone": "#",
"otherInfo": "[]",
"account": {
"platform": "EVO",
"id": 29824,
"name": "Test_EDS1",
"ownership": "#",
"inn": "1010101010",
"kpp": "100000001",
"mail": "test@qw.we",
"phone": "12345678901",
"ndsNumber": "#",
"bankAccount": "#",
"bankName": "#",
"bankMfo": "#",
"bankAddress": "#",
"identificators": [
],
"companies": [
],
"users": [
]
}
}
]
}