Отримання інформації по авторизованому користувачеві¶
Для роботи з цим методом користувач повинен бути авторизованим .
За допомогою метода api/oas/user можливо отримати інформацію про користувача, наприклад ID користувача, ID аккаунта, логін, чи має користувач «права адміністратора» (true / false), дані про платформу і інші ідентифікатори.
Метод запиту |
HTTP GET |
---|---|
Content-Type |
application/json (тіло HTTP запиту / відповіді в json форматі) |
URL запиту |
|
Параметри, що передаються в URL (разом з адресою методу) |
У рядку заголовка (Header) «Cookie» обов’язково передається SID - токен отриманий при авторизації |
Підказка
Також можливо виконати запит у вигляді 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
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт User |
||
id |
long |
id користувача; число |
accountId |
long |
id аккаунта |
login |
String |
логін користувача; рядок 50 символів |
stringEmails |
String |
E-mail; рядок 255 символів |
emails |
List<String> |
масив адрес E-mail |
blocked |
int |
відмітка про блокування; число; 0 - немає, 1 - так |
allowFTP |
int |
відмітка доступу до FTP; число; 0 - немає, 1 - так |
autoSending |
boolean |
автоотправка; число; 0 - Ні, 1 - Так (документи автоматично відправляються при перенесенні документа для відправки в папку outbox) |
statusFile |
int |
створення статус-файлів; число; 0 - Ні, 1 - Так, 2 - Так, про доставку, 3 - Так, про прочитання |
isAdmin |
boolean |
відмітка, чи є користувач адміністратором в управлінні користувачами; число; 0 - немає, 1 - так |
Приклади
При використанні методу json-тіло запиту відсутнє (дані передавати не потрібно)
Приклад тіла відповіді (json):
{
"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": [
]
}
}
]
}