Оновлення компанії з КЕП/ЕЦП¶
Для роботи з цим методом користувач повинен бути авторизованим .
Увага
Оновлення компанії з КЕП/ЕЦП відбувається в два кроки:
Користувачу необхідно отримати унікальний UUID (метод {url сервера}/bdoc/sign_auth_uuid). Далі отриманий UUID необхідно підписати ЕЦП - зовнішнє підписання, в результаті якого користувач отримує .bin-файл.
Користувачу необхідно відправити отриманий .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
Параметр |
Формат |
Опис |
---|---|---|
Об’єкт Company |
||
companyId |
long |
ID компанії |
accountId |
long |
ID аккаунта |
type |
int |
тип компанії (1 - юр. особа; 2 - фіз. особа) |
name |
String |
назва компанії |
legalName |
String |
юридична назва |
inn |
String |
ідентифікаційний номер платника податків |
code |
String |
свідоцтво платника ПДВ |
phone |
String |
телефон |
info |
String |
додаткова інформація |
isApproved |
int |
ознака створення компанії з ЕЦП; можливі значення: 0 - створена звичайним способом; 1 - створена з ЕЦП |
isSignedOffer |
int |
ознака підписана чи оферта; значення за замовчуванням = 0; коментар: 0 - Ні; 1 - Так |
isActive |
int |
статус компанії: активна / деактивовано; значення за замовчуванням = 1; коментар: 0 - Ні; 1 - Так |
ownershipType |
String |
форма власності |
atCode |
String |
код КОАТУУ (Класифікатор об’єктів адміністративно-територіального устрою України) |
certNum |
String |
свідоцтво платника ПДВ |
uuID |
String |
унікальний ідентифікатор компанії |
bankAcc |
об’єкт; банківські реквізити |
|
legalAddress |
об’єкт; юридична адреса |
|
actualAddress |
об’єкт; фактична адреса |
|
fizName |
об’єкт; ПІБ фіз. особи компанії |
|
certificates |
List<Certificate_> |
масив об’єктів; сертифікати |
dictionaries |
List<Dictionary_> |
масив об’єктів; довідники |
notifySettings |
List<EmailNotifySettings_> |
масив об’єктів; налаштування відправки повідомлень на пошту |
Приклади¶
В тілі запиту передається .bin-файл (підписаний UUID).
Приклад тіла відповіді (json):
{
"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": []
}
]
}