Масова реєстрація аккаунтів

Для роботи з цим методом користувач повинен бути авторизованим .

Важливо

У кожного аккаунта повинна бути хоча б одна компанія і один користувач. На підставі отриманих даних в системі будуть створені аккаунти, компанії і користувачі. Всі користувачі, будуть відзначені, як власники аккаунта, компанії не підтверджені ЕЦП.

Метод запиту

HTTP POST

Content-Type

application/json (тіло запиту/відповіді в json форматі в тілі HTTP запиту)

URL запиту

https://doc.edi-n.com/bdoc_admin/register_account_list

Параметри, що передаються в URL (разом з адресою методу)

В рядку заголовка (Header) «Set-Cookie» обов’язково передається SID - токен, отриманий при авторизації

Обов’язкові параметри, що передаються в тілі запиту (json)

accName, companies, users, edrpou, inn, name, ownType, email, fio

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

REQUEST

Таблиця 1 - Опис json-параметрів запиту метода API

Параметр

Mandatory/Optional

Формат

Опис

accName

M

long

назва компанії

companies

M

List<Company>

масив об’єктів з даними компанії

users

M

List<User>

масив об’єктів з даними користувача

Таблиця 2 - Опис параметрів об’єкта 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

BankAcc_

об’єкт; банківські реквізити

legalAddress

Address_

об’єкт; юридична адреса

actualAddress

Address_

об’єкт; фактична адреса

fizName

CompanyFizName_

об’єкт; ПІБ фіз. особи компанії

certificates

List<Certificate_>

масив об’єктів; сертифікати

dictionaries

List<Dictionary_>

масив об’єктів; довідники

notifySettings

List<EmailNotifySettings_>

масив об’єктів; налаштування відправки повідомлень на пошту

Таблиця 2 - Опис параметрів об’єкта User

Параметр

Формат

Опис

Об’єкт User

userId

long

ID користувача

accountId

long

ID аккаунта

email

String

email та логін користувача

password

String

пароль користувача

isOwner

int

ознака власника аккаунта; 0 - ні, 1 - так

isCaptcha

Integer

ознака активації CAPTCHA для користувача («1» - активна; «0» - не активна)

fio

String

ПІБ користувача

tel

String

телефон

companies

List<Company>

масив об’єктів; компанії

account

Account_

об’єкт; дані облікового запису

status

int

статус користувача («1» - активний; «2» - заблокований)

roles

List<Role_>

масив об’єктів; ролі

routes

List<PackageRoute_>

масив об’єктів; маршрути

passSecureType

int

рівень складності пароля («1» - низький; «2» - звичайний; «3» - високий)

passPolicyId

long

id пральний політики, застосованої до користувача

userInfo

UserInfo_

об’єкт; інформація про користувача

lastLoginIp

String

IP-адреса останнього входу

lastLoginDate

long

дата останнього входу

uiTypes

List<UIType2Role_>

масив об’єктів; зв’язки користувальницьких інтерфейсів і ролей

RESPONSE

Таблиця 3 - Опис json-параметрів відповіді метода API

Параметр

Формат

Опис

accName

long

назва компанії

companies

List<Company>

масив об’єктів з даними компанії

users

List<User>

масив об’єктів з даними користувача

handleResult

повідомлення щодо дії запиту;

created - «1» створено / «0» - не створено

error - опис помилки, якщо created = «0»

додається в кожний json елемент компанії


Приклади

Приклад тіла запиту (json):

{
[
  {
    "accName": "Летюд ТОВ",
    "companies": [
      {
        "edrpou": "1212",
        "inn": "1243546556",
        "name": "Летюд",
        "ownType": "ТОВ"
      },
      {
        "edrpou": "435465",
        "inn": "124354653454556",
        "name": "Летюдewewe",
        "ownType": "ТОВ"
      }
    ],
    "users": [
      {
        "email": "[email protected]",
        "fio": "Иванов Иван"
      },
      {
        "email": "[email protected]",
        "fio": "Иванов2 Иван2"
      }
    ]
  },
  {
    "accName": "ФОП Сокол О.В.",
    "companies": [
      {
        "edrpou": "343434",
        "inn": "3435467",
        "name": "Сокол О.В.",
        "ownType": "ФОП"
      }
    ],
    "users": [
      {
        "email": "[email protected]",
        "fio": "Иванов Иван"
      }
    ]
  }
]
}

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

{
[
    {
        "accName": "Летюд ТОВ",
        "companies": [
            {
                "edrpou": "1212",
                "inn": "1243546556",
                "name": "Летюд",
                "ownType": "ТОВ"
            },
            {
                "edrpou": "435465",
                "inn": "124354653454556",
                "name": "Летюдewewe",
                "ownType": "ТОВ"
            }
        ],
        "handleResult": {
            "created": 1
        },
        "users": [
            {
                "email": "[email protected]",
                "fio": "Иванов Иван",
                "handleResult": {
                    "created": 1
                }
            },
            {
                "email": "[email protected]",
                "fio": "Иванов2 Иван2",
                "handleResult": {
                    "created": 1
                }
            }
        ]
    },
    {
        "accName": "ФОП Сокол О.В.",
        "companies": [
            {
                "edrpou": "343434",
                "handleResult": {
                    "created": 0,
                    "error": "compnay allready exisrts"
                },
                "inn": "3435467",
                "name": "Сокол О.В.",
                "ownType": "ФОП"
            }
        ],
        "handleResult": {
            "created": 1
        },
        "users": [
            {
                "email": "[email protected]",
                "fio": "Иванов Иван",
                "handleResult": {
                    "created": 1
                }
            }
        ]
    }
]
}