Core42 – центральная служба 42Облака, обеспечивающая аутентификацию
и авторизацию пользователей, формирующая структуру аккаунтов, пользователей, баз данных и
различных ресурсов. Обеспечивает их взаимодействие и доступ к этим данным для других служб.
Архитектурным стандартом построения API ядра является
REST.
Входные параметры GET-методов передаются в строке запроса.
Входные параметры POST-методов передаются в теле запроса в формате XML (Content-type:
application/xml).
В заголовке каждого ответа передается код его статуса.
В теле ответа возвращается результат запроса в формате XML (Content-type: application/xml).
В случае возникновения ошибки (код статуса ответа 400 и выше) в теле ответа возвращается
информация об ошибке в формате XML (Content-type: application/xml).
Accounts
Содержит аккаунты облака, представляющие собой
группировки пользователей, баз данных и других объектов и данных
Add
Создание и добавление нового аккаунта. Одновременно происходит создание
пользователя с ролью администратора данного аккаунта
POST
Параметры метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountCaption | String | наименование аккаунта (например, название компании) |
| Login | String | логин пользователя с ролью администратора аккаунта |
| Password | String | пароль пользователя с ролью администратора |
| String | электронный адрес пользователя с ролью администратора | |
| PhoneCountry | String | код страны пользователя с ролью администратора |
| PhoneNumber | String | номер телефона пользователя с ролью администратора |
| FirstName | String | имя пользователя с ролью администратора аккаунта |
| LastName | String | фамилия пользователя с ролью администратора аккаунта |
| MiddleName | String | отчество пользователя с ролью администратора аккаунта |
| ReferralAccountID | Guid | идентификатор партнерского аккаунта |
Результат метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountID | guid | идентификатор нового аккаунта |
Возможные ошибки метода:
| Код ошибки | Описание ошибки |
| 409 | пользователь с одним из указанных уникальных свойств уже существует |
| 412 | значение свойства аккаунта или пользователя не указано или не соответствует необходимому формату |
XML-формат тела запроса:
application/xml, text/xml
Sample: <Request> <AccountId>c6c77817-fce1-4305-9dbc-3a56a0976ba9</AccountId> <Login>testlogin</Login> <Password>testpassword</Password> <Email>test@email.ru</Email> <PhoneCountry>RU</PhoneCountry> <PhoneNumber>0970979797</PhoneNumber> <FirstName>Иван</FirstName> <LastName>Федоров</LastName> <MiddleName>Евгеньевич</MiddleName> </Request>
XML-формат тела ответа:
application/xml, text/xml
Sample: <Result> <Code>07914c1a-e91b-4e42-a483-53297d3f77b9</Code> </Result>
GetIDs
Возвращает список идентификаторов аккаунтов в заданном диапазоне по времени их
создания. Максимально количество возвращаемых идентификаторов – 1000.
GET
Параметры метода:
| Имя параметра | Тип параметра | Описание параметра |
| RegistrationDateFrom | datetime | дата начала диапазона времени создания аккаунта |
| RegistrationDateTo | datetime | дата конца диапазона времени создания аккаунта |
Результат метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountIDs | list [guid] | список идентификаторов аккаунтов |
Возможные ошибки метода:
| Код ошибки | Описание ошибки |
| 412 | возвращаемое количество идентификаторов аккаунтов более 1000 |
XML-формат тела ответа:
application/xml, text/xml
Sample:
<Result>
<AccountIDs>
<Item>4513cdb1-7f45-4bdc-8167-bae7c65f9c3e</Item>
<Item>fabc2906-145f-4c85-b292-a2cbcb3d2a16</Item>
<Item>99cd1c9a-15e7-4ea0-9d8b-ff203dd03d09</Item>
</AccountIDs>
</Result>
GetProperties
Получение основных свойств аккаунта с указанным идентификатором
GET
Параметры метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountID | guid | идентификатор аккаунта |
Результат метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountCaption | String | наименование аккаунта |
| ReferralAccountID | guid | идентификатор партнерского аккаунта |
| RegistrationDate | datetime | дата создания аккаунта |
| IndexNumber | integer | уникальный целочисленный номер аккаунта |
Возможные ошибки метода:
| Код ошибки | Описание ошибки |
| 404 | аккаунта с указанным идентификатором не существует |
XML-формат тела ответа:
application/xml, text/xml
Sample: <Result> <AccountCaption>ООО ТоргСофт</AccountCaption> <ReferralAccountID>cc1d477c-3900-4149-bd78-79fb4b36384a</ReferralAccountID> <RegistrationDate>2014-11-21T16:53:16+04:00</RegistrationDate> <IndexNumber>4256</IndexNumber> <Removed>true</Removed> </Result>
Delete
Удаление аккаунта
POST
Параметры метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountID | guid | идентификатор аккаунта |
Возможные ошибки метода:
| Код ошибки | Описание ошибки |
| 404 | аккаунта с указанным идентификатором не существует |
XML-формат тела запроса:
application/xml, text/xml
Sample: <Request> <AccountID>620ab1b3-943b-453f-a73a-73c70cda716e</AccountID> </Request>
XML-формат тела ответа:
application/xml, text/xml
Sample: <Result />
Count
Возвращает общее количество аккаунтов в ядре
GET
Результат метода:
| Имя параметра | Тип параметра | Описание параметра |
| Count | int | количество элементов списка |
XML-формат тела ответа:
application/xml, text/xml
Sample: <Result> <Count>1</Count> </Result>
SetAccountCaption
Создание и добавление нового аккаунта. Одновременно происходит создание
пользователя с ролью администратора данного аккаунта
POST
Параметры метода:
| Имя параметра | Тип параметра | Описание параметра |
| AccountID | guid | идентификатор аккаунта |
| AccountCaption | string | новое значение наименования аккаунта |
Возможные ошибки метода:
| Код ошибки | Описание ошибки |
| 404 | аккаунта с указанным идентификатором не существует |
XML-формат тела запроса:
application/xml, text/xml
