API сервисов .ART
API Endpoint
https://services.art.art/api/v2Сервер авторизации ¶
Авторизация ¶
Headers
Content-Type: application/json
Accept-Language: en
Body
{
"grant_type": "client_credentials",
"client_id": "test",
"client_secret": "********"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"enum": [
"client_credentials"
],
"description": "Тип авторизации"
},
"client_id": {
"type": "string",
"enum": [
"test"
],
"description": "Клиентское приложение"
},
"client_secret": {
"type": "string",
"enum": [
"********"
],
"description": "Пароль клиентского приложения"
}
},
"required": [
"grant_type",
"client_id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"token_type": "Bearer",
"access_token": "jwt",
"refresh_token": "jwt",
"expires_in": 3600
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token_type": {
"type": "string",
"enum": [
"Bearer"
],
"description": "Тип ключа"
},
"access_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ доступа (JWT)"
},
"refresh_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ продления доступа"
},
"expires_in": {
"type": "number",
"enum": [
3600
],
"description": "Срок действия ключа доступа (в секундах)"
}
},
"required": [
"token_type",
"access_token"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "invalid_credentials",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_credentials"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Body
{
"grant_type": "password",
"client_id": "test",
"client_secret": "********",
"username": "user@example.art",
"password": "********"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"enum": [
"password"
],
"description": "Тип авторизации"
},
"client_id": {
"type": "string",
"enum": [
"test"
],
"description": "Клиентское приложение"
},
"client_secret": {
"type": "string",
"enum": [
"********"
],
"description": "Пароль клиентского приложения"
},
"username": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Имя пользователя"
},
"password": {
"type": "string",
"enum": [
"********"
],
"description": "Пароль"
}
},
"required": [
"grant_type",
"client_id",
"username",
"password"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"token_type": "Bearer",
"access_token": "jwt",
"refresh_token": "jwt",
"expires_in": 3600
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token_type": {
"type": "string",
"enum": [
"Bearer"
],
"description": "Тип ключа"
},
"access_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ доступа (JWT)"
},
"refresh_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ продления доступа"
},
"expires_in": {
"type": "number",
"enum": [
3600
],
"description": "Срок действия ключа доступа (в секундах)"
}
},
"required": [
"token_type",
"access_token"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "invalid_credentials",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_credentials"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Body
{
"grant_type": "authorization_code",
"client_id": "test",
"client_secret": "********",
"code": "abc"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"enum": [
"authorization_code"
],
"description": "Тип авторизации"
},
"client_id": {
"type": "string",
"enum": [
"test"
],
"description": "Клиентское приложение"
},
"client_secret": {
"type": "string",
"enum": [
"********"
],
"description": "Пароль клиентского приложения"
},
"code": {
"type": "string",
"enum": [
"abc"
],
"description": "Код авторизации"
}
},
"required": [
"grant_type",
"client_id",
"code"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"token_type": "Bearer",
"access_token": "jwt",
"refresh_token": "jwt",
"expires_in": 3600
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token_type": {
"type": "string",
"enum": [
"Bearer"
],
"description": "Тип ключа"
},
"access_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ доступа (JWT)"
},
"refresh_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ продления доступа"
},
"expires_in": {
"type": "number",
"enum": [
3600
],
"description": "Срок действия ключа доступа (в секундах)"
}
},
"required": [
"token_type",
"access_token"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "invalid_credentials",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_credentials"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Body
{
"grant_type": "refresh_token",
"client_id": "test",
"client_secret": "********",
"refresh_token": "abc"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"enum": [
"refresh_token"
],
"description": "Тип авторизации"
},
"client_id": {
"type": "string",
"enum": [
"test"
],
"description": "Клиентское приложение"
},
"client_secret": {
"type": "string",
"enum": [
"********"
],
"description": "Пароль клиентского приложения"
},
"refresh_token": {
"type": "string",
"enum": [
"abc"
],
"description": "Ключ продления доступа"
}
},
"required": [
"grant_type",
"client_id",
"refresh_token"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"token_type": "Bearer",
"access_token": "jwt",
"refresh_token": "jwt",
"expires_in": 3600
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token_type": {
"type": "string",
"enum": [
"Bearer"
],
"description": "Тип ключа"
},
"access_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ доступа (JWT)"
},
"refresh_token": {
"type": "string",
"enum": [
"jwt"
],
"description": "Ключ продления доступа"
},
"expires_in": {
"type": "number",
"enum": [
3600
],
"description": "Срок действия ключа доступа (в секундах)"
}
},
"required": [
"token_type",
"access_token"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "invalid_credentials",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_credentials"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Получение ключа доступаPOST/auth/token
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"username": "user@example.art"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"username": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Имя пользователя"
}
},
"required": [
"username"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Сброс пароляPOST/auth/password
Учетные записи ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update_password",
"update_scope"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"email": "user@example.art",
"firstname": "Max",
"lastname": "Pryakhin",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"scopes": [
"admin"
]
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update_password"
]
},
{
"type": "string",
"enum": [
"update_scope"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin"
]
},
"description": "Права доступа"
}
},
"required": [
"_acl",
"id",
"email",
"firstname",
"lastname",
"created_at",
"updated_at",
"scopes"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр учетных записейGET/auth/accounts{?username,limit,offset}
- username
string
(optional) Example: user@example.artИмя пользователя
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"update_password",
"update_scope"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"email": "user@example.art",
"firstname": "Max",
"lastname": "Pryakhin",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"scopes": [
"admin"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update_password"
]
},
{
"type": "string",
"enum": [
"update_scope"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"scopes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"admin"
]
},
"description": "Права доступа"
}
},
"required": [
"_acl",
"id",
"email",
"firstname",
"lastname",
"created_at",
"updated_at",
"scopes"
],
"additionalProperties": false
}
Просмотр учетной записиGET/auth/accounts/{account}
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
Headers
Accept-Language: en
Authorization: Bearer JWT
Body
{
"email": "user@example.art",
"password": "********",
"firstname": "Max",
"lastname": "Pryakhin"
}
Schema
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Почта"
},
"password": {
"type": "string",
"description": "Пароль"
},
"firstname": {
"type": "string",
"description": "Имя"
},
"lastname": {
"type": "string",
"description": "Фамилия"
}
},
"required": [
"email",
"password",
"firstname",
"lastname"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Добавление учетной записиPOST/auth/accounts
Headers
Accept-Language: en
Authorization: Bearer JWT
Body
{
"email": "user@example.art",
"firstname": "Max",
"lastname": "Pryakhin"
}
Schema
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Почта"
},
"firstname": {
"type": "string",
"description": "Имя"
},
"lastname": {
"type": "string",
"description": "Фамилия"
}
},
"required": [
"email",
"firstname",
"lastname"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение учетной записиPATCH/auth/accounts/{account}
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
Headers
Accept-Language: en
Authorization: Bearer JWT
Body
{
"password": "********"
}
Schema
{
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "Пароль"
}
},
"required": [
"password"
],
"$schema": "http://json-schema.org/draft-04/schema#"
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение пароляPUT/auth/accounts/{account}/password
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"code": "abc"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"abc"
],
"description": "Код подтверждения"
}
},
"required": [
"code"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Подтверждение учетной записиPUT/auth/accounts/{account}/verify
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
Headers
Accept-Language: en
Authorization: Bearer JWT
Запрос кода подтвержденияPOST/auth/accounts/{account}/code
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
Headers
Accept-Language: en
Authorization: Bearer JWT
Включение доступаPUT/auth/accounts/{account}/scopes/{scope}
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
- scope
string
(required) Example: adminПраво доступа
Headers
Accept-Language: en
Authorization: Bearer JWT
Выключение доступаDELETE/auth/accounts/{account}/scopes/{scope}
- account
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Учетная запись
- scope
string
(required) Example: adminПраво доступа
WHMCS ¶
Клиенты ¶
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update"
],
"id": 12345,
"status": "active",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UK Creative Ideas Ltd.",
"vat": "GB004618015",
"phone": "+7.9161234567",
"email": "client@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2K7, 301"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата регистрации (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Ltd."
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.9161234567"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"client@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2K7, 301"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"_acl",
"id",
"status",
"created_at",
"updated_at",
"firstname",
"lastname",
"phone",
"email",
"address"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр клиентовGET/whmcs/clients{?status,email,limit,offset}
- status
string
(optional) Example: activeСтатус
string
(optional) Example: client@example.artПочта
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"_acl": [
"update"
],
"id": 12345,
"status": "active",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UK Creative Ideas Ltd.",
"vat": "GB004618015",
"phone": "+7.9161234567",
"email": "client@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2K7, 301"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата регистрации (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Ltd."
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.9161234567"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"client@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2K7, 301"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"_acl",
"id",
"status",
"created_at",
"updated_at",
"firstname",
"lastname",
"phone",
"email",
"address"
],
"additionalProperties": false
}
Просмотр клиентаGET/whmcs/clients/{client}
- client
string
(required) Example: 12345Клиент
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UK Creative Ideas Ltd.",
"vat": "GB004618015",
"phone": "+7.9161234567",
"email": "client@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2K7, 301"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Ltd."
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.9161234567"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"client@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2K7, 301"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"firstname",
"lastname",
"phone",
"email",
"address"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": 12345
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Регистрация клиентаPOST/whmcs/clients
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UK Creative Ideas Ltd.",
"vat": "GB004618015",
"phone": "+7.9161234567",
"email": "client@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2K7, 301"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Ltd."
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.9161234567"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"client@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2K7, 301"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"firstname",
"lastname",
"phone",
"email",
"address"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение клиентаPOST/whmcs/clients/{client}/update
- client
string
(required) Example: 12345Клиент
Домены ¶
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update"
],
"id": 12345,
"client": 12345,
"domain": "example.art",
"status": "active",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"expired_at": "2017-06-20T03:14:21+0000",
"nameserver1": "ns1.example.art",
"nameserver2": "ns2.example.art",
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата регистрации (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата окончания срока действия (в формате ISO 8601)"
},
"nameserver1": {
"type": "string",
"enum": [
"ns1.example.art"
],
"description": "Сервер NS1"
},
"nameserver2": {
"type": "string",
"enum": [
"ns2.example.art"
],
"description": "Сервер NS2"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"_acl",
"id",
"client",
"domain",
"status",
"created_at",
"updated_at",
"expired_at",
"nameserver1",
"nameserver2",
"artwork"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр доменовGET/whmcs/domains{?client,domain,status,limit,offset}
- client
string
(optional) Example: 12345Клиент
- domain
string
(optional) Example: example.artДомен
- status
string
(optional) Example: activeСтатус
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"_acl": [
"update"
],
"id": 12345,
"client": 12345,
"domain": "example.art",
"status": "active",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"expired_at": "2017-06-20T03:14:21+0000",
"nameserver1": "ns1.example.art",
"nameserver2": "ns2.example.art",
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата регистрации (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата окончания срока действия (в формате ISO 8601)"
},
"nameserver1": {
"type": "string",
"enum": [
"ns1.example.art"
],
"description": "Сервер NS1"
},
"nameserver2": {
"type": "string",
"enum": [
"ns2.example.art"
],
"description": "Сервер NS2"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"_acl",
"id",
"client",
"domain",
"status",
"created_at",
"updated_at",
"expired_at",
"nameserver1",
"nameserver2",
"artwork"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"nameserver1": "ns1.example.art",
"nameserver2": "ns2.example.art",
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"nameserver1": {
"type": "string",
"enum": [
"ns1.example.art"
],
"description": "Сервер NS1"
},
"nameserver2": {
"type": "string",
"enum": [
"ns2.example.art"
],
"description": "Сервер NS2"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"nameserver1",
"nameserver2",
"artwork"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение доменаPOST/whmcs/domains/{domain}/update
- domain
string
(required) Example: 12345Домен
Заказы ¶
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update"
],
"id": 12345,
"client": 12345,
"status": "unpaid",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"items": [
{
"service": "domain",
"domain": "example.art",
"quantity": 1,
"period": 12
}
]
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"status": {
"type": "string",
"enum": [
"unpaid"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"domain"
],
"description": "Услуга"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Доменное имя"
},
"quantity": {
"type": "number",
"enum": [
1
],
"description": "Количество"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
}
},
"required": [
"service",
"domain",
"quantity",
"period"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"items"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр заказовGET/whmcs/orders{?client,status,limit,offset}
- client
string
(optional) Example: 12345Клиент
- status
string
(optional) Example: activeСтатус
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"_acl": [
"update"
],
"id": 12345,
"client": 12345,
"status": "unpaid",
"created_at": "2017-06-20T03:14:21+0000",
"updated_at": "2017-06-20T03:14:21+0000",
"items": [
{
"service": "domain",
"domain": "example.art",
"quantity": 1,
"period": 12
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"status": {
"type": "string",
"enum": [
"unpaid"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"domain"
],
"description": "Услуга"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Доменное имя"
},
"quantity": {
"type": "number",
"enum": [
1
],
"description": "Количество"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
}
},
"required": [
"service",
"domain",
"quantity",
"period"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"client": 12345,
"items": [
{
"service": "domain",
"domain": "example.art",
"quantity": 1,
"period": 12,
"price": {
"amount": 18.99,
"currency": "USD"
},
"nameserver1": "ns1.example.art",
"nameserver2": "ns2.example.art",
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"domain"
],
"description": "Услуга"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Доменное имя"
},
"quantity": {
"type": "number",
"enum": [
1
],
"description": "Количество"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена за единицу"
},
"nameserver1": {
"type": "string",
"enum": [
"ns1.example.art"
],
"description": "Сервер NS1"
},
"nameserver2": {
"type": "string",
"enum": [
"ns2.example.art"
],
"description": "Сервер NS2"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service",
"domain",
"quantity",
"period",
"price",
"nameserver1",
"nameserver2",
"artwork"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"client",
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": 12345
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Оформление заказаPOST/whmcs/orders
Счета ¶
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"_acl": [
"pay"
],
"id": 12345,
"client": 12345,
"status": "unpaid",
"created_at": "2017-06-20T03:14:21+0000",
"paid_at": "2017-06-20T03:14:21+0000",
"items": [
{
"description": "Domain Registration - example.art, 3 year/s",
"price": {
"amount": 18.99,
"currency": "USD"
}
}
],
"subtotal": {
"amount": 18.99,
"currency": "USD"
},
"credit": {
"amount": 18.99,
"currency": "USD"
},
"tax": {
"rate": 23,
"amount": 4.36,
"currency": "USD"
},
"total": {
"amount": 18.99,
"currency": "USD"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pay"
]
},
"description": "Права доступа"
},
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
},
"client": {
"type": "number",
"enum": [
12345
],
"description": "Клиент"
},
"status": {
"type": "string",
"enum": [
"unpaid"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"paid_at": {
"type": "string",
"enum": [
"2017-06-20T03:14:21+0000"
],
"description": "Дата оплаты (в формате ISO 8601)"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Domain Registration - example.art, 3 year/s"
],
"description": "Описание"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
}
},
"required": [
"description",
"price"
],
"additionalProperties": false
},
"description": "Позиции заказа"
},
"subtotal": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Итоговая цена без НДС"
},
"credit": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Собственные средства"
},
"tax": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"enum": [
23
],
"description": "Ставка"
},
"amount": {
"type": "number",
"enum": [
4.36
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"rate",
"amount",
"currency"
],
"additionalProperties": false,
"description": "НДС"
},
"total": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Итоговая цена c НДС"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"items",
"subtotal",
"credit",
"tax",
"total"
],
"additionalProperties": false
}
Просмотр счетаGET/whmcs/orders/{order}/invoice
- order
number
(required) Example: 12345Заказ
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"transaction": "38486450",
"payer": "93187370",
"card": {
"type": "CREDIT",
"system": "VISA",
"number": "1111",
"cardholder": "Max Pryakhin"
},
"price": {
"amount": 18.99,
"currency": "USD"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transaction": {
"type": "string",
"enum": [
"38486450"
],
"description": "Транзакция"
},
"payer": {
"type": "string",
"enum": [
"93187370"
],
"description": "Плательщик"
},
"card": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"CREDIT"
],
"description": "Тип карты"
},
"system": {
"type": "string",
"enum": [
"VISA"
],
"description": "Платежная система"
},
"number": {
"type": "string",
"enum": [
"1111"
],
"description": "Последние 4 цифры номера карты"
},
"cardholder": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Владелец карты"
}
},
"required": [
"type",
"system",
"number",
"cardholder"
],
"additionalProperties": false,
"description": "Кредитная карта"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
}
},
"required": [
"transaction",
"payer",
"card",
"price"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": 12345
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "number",
"enum": [
12345
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Оплата счетаPOST/whmcs/orders/{order}/invoice/pay
- order
number
(required) Example: 12345Заказ
Реестр доменов ¶
События ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"pending",
"processing",
"completed",
"skipped"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"pending"
]
},
{
"type": "string",
"enum": [
"processing"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"skipped"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов событияGET/registry/events/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "pending",
"type": "update",
"domain": "example.art",
"registrar": "H3105376",
"domain_fails": 0,
"contact_fails": 1,
"max_fails": 5,
"created_at": "2019-07-25T13:18:46+0000",
"received_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"pending"
],
"description": "Статус"
},
"type": {
"type": "string",
"enum": [
"update"
],
"description": "Тип"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"domain_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество ошибок получения данных домена"
},
"contact_fails": {
"type": "number",
"enum": [
1
],
"description": "Количество ошибок получения контактных данных"
},
"max_fails": {
"type": "number",
"enum": [
5
],
"description": "Максимальное количество ошибок получения контактных данных"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"received_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата получения (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"type",
"domain",
"registrar",
"domain_fails",
"contact_fails",
"max_fails",
"created_at",
"received_at",
"updated_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр событийGET/registry/events{?status,domain,registrar,limit,offset}
- status
string
(optional) Example: pendingСтатус
- domain
string
(optional) Example: example.artДомен
- registrar
string
(optional) Example: H3105376Регистратор
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "pending",
"type": "update",
"domain": "example.art",
"registrar": "H3105376",
"domain_fails": 0,
"contact_fails": 1,
"max_fails": 5,
"created_at": "2019-07-25T13:18:46+0000",
"received_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"pending"
],
"description": "Статус"
},
"type": {
"type": "string",
"enum": [
"update"
],
"description": "Тип"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"domain_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество ошибок получения данных домена"
},
"contact_fails": {
"type": "number",
"enum": [
1
],
"description": "Количество ошибок получения контактных данных"
},
"max_fails": {
"type": "number",
"enum": [
5
],
"description": "Максимальное количество ошибок получения контактных данных"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"received_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата получения (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"type",
"domain",
"registrar",
"domain_fails",
"contact_fails",
"max_fails",
"created_at",
"received_at",
"updated_at"
],
"additionalProperties": false
}
Просмотр событияGET/registry/events/{event}
- event
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Событие
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
X-API-Key: api-key
Body
{
"i": "epp",
"e": "update",
"t": "domain",
"o": "example.art",
"r": "H3105376",
"z": "art",
"s": "1562862495.950"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"i": {
"type": "string",
"enum": [
"epp"
],
"description": "Интерфейс (может быть WHOIS или EPP, у нас всегда EPP)"
},
"e": {
"type": "string",
"enum": [
"update"
],
"description": "Тип события (create или update)"
},
"t": {
"type": "string",
"enum": [
"domain"
],
"description": "Тип объекта (у нас всегда domain)"
},
"o": {
"type": "string",
"enum": [
"example.art"
],
"description": "Объект (домен)"
},
"r": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"z": {
"type": "string",
"enum": [
"art"
],
"description": "Доменная зона (у нас всегда art)"
},
"s": {
"type": "string",
"enum": [
"1562862495.950"
],
"description": "Дата создания (в формате Unix-Timestamp)"
}
},
"required": [
"i",
"e",
"t",
"o",
"r",
"z",
"s"
],
"additionalProperties": false
}
Регистрация события SyslogPOST/registry/events/syslog
Обработчики изменений ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"active",
"unavailable",
"locked"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"active"
]
},
{
"type": "string",
"enum": [
"unavailable"
]
},
{
"type": "string",
"enum": [
"locked"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов обработчикаGET/registry/handlers/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"lock",
"unlock",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "active",
"url": "https://example.art",
"unavailable_fails": 0,
"snapshots_queue": 0,
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"check_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"lock"
]
},
{
"type": "string",
"enum": [
"unlock"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"url": {
"type": "string",
"enum": [
"https://example.art"
],
"description": "URL"
},
"unavailable_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество отказов"
},
"snapshots_queue": {
"type": "number",
"enum": [
0
],
"description": "Количество снимков в очереди"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"check_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата следующей проверки (в формате ISO 8601)"
}
},
"required": [
"_acl",
"id",
"status",
"url",
"unavailable_fails",
"snapshots_queue",
"created_at",
"updated_at",
"check_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр обработчиковGET/registry/handlers{?status,limit,offset}
- status
string
(optional) Example: activeСтатус
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"lock",
"unlock",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "active",
"url": "https://example.art",
"unavailable_fails": 0,
"snapshots_queue": 0,
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"check_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"lock"
]
},
{
"type": "string",
"enum": [
"unlock"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"url": {
"type": "string",
"enum": [
"https://example.art"
],
"description": "URL"
},
"unavailable_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество отказов"
},
"snapshots_queue": {
"type": "number",
"enum": [
0
],
"description": "Количество снимков в очереди"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"check_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата следующей проверки (в формате ISO 8601)"
}
},
"required": [
"_acl",
"id",
"status",
"url",
"unavailable_fails",
"snapshots_queue",
"created_at",
"updated_at",
"check_at"
],
"additionalProperties": false
}
Просмотр обработчикаGET/registry/handlers/{handler}
- handler
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Обработчик
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"url": "https://example.art"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://example.art"
],
"description": "URL"
}
},
"required": [
"url"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Добавление обработчикаPOST/registry/handlers
Headers
Accept-Language: en
Authorization: Bearer JWT
Блокировка обработчикаPUT/registry/handlers/{handler}/lock
- handler
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Обработчик
Headers
Accept-Language: en
Authorization: Bearer JWT
Разблокировка обработчикаDELETE/registry/handlers/{handler}/lock
- handler
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Обработчик
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление обработчикаDELETE/registry/handlers/{handler}
- handler
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Обработчик
Сервера ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"active",
"unavailable",
"unsupported",
"locked"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"active"
]
},
{
"type": "string",
"enum": [
"unavailable"
]
},
{
"type": "string",
"enum": [
"unsupported"
]
},
{
"type": "string",
"enum": [
"locked"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов сервераGET/registry/servers/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "whois.nic.art",
"status": "active",
"registrar": "H3105376",
"unavailable_fails": 0,
"lock_fails": 1,
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"check_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"whois.nic.art"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"unavailable_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество отказов из-за недоступности"
},
"lock_fails": {
"type": "number",
"enum": [
1
],
"description": "Количество отказов из-за блокировки"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"check_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата следующей проверки (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"registrar",
"unavailable_fails",
"lock_fails",
"created_at",
"updated_at",
"check_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр серверовGET/registry/servers{?status,registrar,limit,offset}
- status
string
(optional) Example: activeСтатус
- registrar
string
(optional) Example: H3105376Регистратор
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"id": "whois.nic.art",
"status": "active",
"registrar": "H3105376",
"unavailable_fails": 0,
"lock_fails": 1,
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"check_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"whois.nic.art"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"unavailable_fails": {
"type": "number",
"enum": [
0
],
"description": "Количество отказов из-за недоступности"
},
"lock_fails": {
"type": "number",
"enum": [
1
],
"description": "Количество отказов из-за блокировки"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"check_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата следующей проверки (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"registrar",
"unavailable_fails",
"lock_fails",
"created_at",
"updated_at",
"check_at"
],
"additionalProperties": false
}
Просмотр сервераGET/registry/servers/{server}
- server
string
(required) Example: whois.nic.artСервер
Домены ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"active",
"expired",
"deleted",
"unregistered"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"active"
]
},
{
"type": "string",
"enum": [
"expired"
]
},
{
"type": "string",
"enum": [
"deleted"
]
},
{
"type": "string",
"enum": [
"unregistered"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов доменаGET/registry/domains/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "example.art",
"status": "active",
"registrar": "H3105376",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"example.art"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"registrar",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр доменовGET/registry/domains{?status,registrar,limit,offset}
- status
string
(optional) Example: activeСтатус
- registrar
string
(optional) Example: H3105376Регистратор
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"id": "example.art",
"status": "active",
"registrar": "H3105376",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"example.art"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"registrar": {
"type": "string",
"enum": [
"H3105376"
],
"description": "Регистратор"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"status",
"registrar",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Просмотр доменаGET/registry/domains/{domain}
- domain
string
(required) Example: example.artДомен
Реестр резервных имен ¶
Списки резервных имен ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
},
"status": "available",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
},
"status": {
"type": "string",
"enum": [
"available"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"domain",
"price",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Список резервных именGET/reserved{?domain,limit,offset}
- domain
string
(required) Example: testДоменное имя
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
}
},
"required": [
"domain",
"price"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
},
"status": "available",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
},
"status": {
"type": "string",
"enum": [
"available"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"domain",
"price",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Добавление резервного имениPOST/reserved
Резервные имена ¶
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
},
"status": "available",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
},
"status": {
"type": "string",
"enum": [
"available"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"domain",
"price",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Просмотр резервного имениGET/reserved/{reserved}
- reserved
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Резервное имя
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"price": {
"amount": 18.99,
"currency": "USD"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Сумма"
},
"currency": {
"type": "string",
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"description": "Цена"
}
},
"required": [
"price"
]
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
},
"status": "available",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
},
"status": {
"type": "string",
"enum": [
"available"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"domain",
"price",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение цены резервного имениPUT/reserved/{reserved}/price
- reserved
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Резервное имя
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "test",
"price": {
"amount": 18.99,
"currency": "USD"
},
"status": "available",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"domain": {
"type": "string",
"enum": [
"test"
],
"description": "Зарезервированный домен"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена"
},
"status": {
"type": "string",
"enum": [
"available"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"domain",
"price",
"status",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Возврат резервного имени в оборотDELETE/reserved/{reserved}/reservation
- reserved
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Резервное имя
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Удаление резервного имениDELETE/reserved/{reserved}
- reserved
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Резервное имя
Магазин доменов ¶
Справочники ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"service_type": "certificate_registration",
"domain": "example.art",
"period": 120,
"best": true,
"available": true,
"premium": true,
"random": true,
"reserved": true,
"price": {
"amount": 18.99,
"currency": "USD"
},
"discounted": {
"amount": 18.99,
"currency": "USD"
},
"promo": "BANANA",
"promo_description": "30% OFF"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"period": {
"type": "number",
"enum": [
120
],
"description": "Срок действия (в месяцах)"
},
"best": {
"type": "boolean",
"enum": [
true
],
"description": "Наилучшее предложение"
},
"available": {
"type": "boolean",
"enum": [
true
],
"description": "Домен доступен для регистрации"
},
"premium": {
"type": "boolean",
"enum": [
true
],
"description": "Премиальный домен"
},
"random": {
"type": "boolean",
"enum": [
true
],
"description": "Мусорный домен"
},
"reserved": {
"type": "boolean",
"enum": [
true
],
"description": "Резервное доменное имя"
},
"price": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена без скидки"
},
"discounted": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Цена с учетом скидки"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"promo_description": {
"type": "string",
"enum": [
"30% OFF"
],
"description": "Краткое описание промо-кода"
}
},
"required": [
"service_type",
"domain",
"period",
"best",
"available",
"premium",
"random",
"reserved",
"price",
"discounted",
"promo",
"promo_description"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр подсказокGET/store/suggestions{?service_type,search,promo,limit,offset}
- service_type
string
(optional) Example: certificate_registrationТип услуги
- search
string
(optional) Example: example.artСтрока поиска
- promo
string
(optional) Example: BANANAПромо-код
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Домены ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"active",
"expired",
"unregistered"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"active"
]
},
{
"type": "string",
"enum": [
"expired"
]
},
{
"type": "string",
"enum": [
"unregistered"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов доменаGET/store/domains/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"renew",
"transfer_to_client"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"idn": "пример.art",
"name": "xn--e1afmkfd.art",
"status": "active",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"max_renew": 60,
"nameservers": [
"ns1.example.art",
"ns2.example.art"
],
"contact": {
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"phone": "+7.4952584471",
"email": "user@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"renew"
]
},
{
"type": "string",
"enum": [
"transfer_to_client"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"idn": {
"type": "string",
"enum": [
"пример.art"
],
"description": "Интернационализованное наименование"
},
"name": {
"type": "string",
"enum": [
"xn--e1afmkfd.art"
],
"description": "Наименование"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата окончания срока действия (в формате ISO 8601)"
},
"max_renew": {
"type": "number",
"enum": [
60
],
"description": "Максимально возможный период продления (в месяцах)"
},
"nameservers": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"ns1.example.art"
]
},
{
"type": "string",
"enum": [
"ns2.example.art"
]
}
],
"description": "DNS-сервера"
},
"contact": {
"type": "object",
"properties": {
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"firstname",
"lastname",
"organization",
"phone",
"email",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"_acl",
"id",
"client",
"idn",
"name",
"status",
"created_at",
"updated_at",
"max_renew",
"nameservers",
"contact",
"artwork"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр доменовGET/store/domains{?client,domain,status,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- domain
string
(optional) Example: example.artДомен
- status
string
(optional) Example: activeСтатус
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"renew",
"transfer_to_client"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"idn": "пример.art",
"name": "xn--e1afmkfd.art",
"status": "active",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"max_renew": 60,
"nameservers": [
"ns1.example.art",
"ns2.example.art"
],
"contact": {
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"phone": "+7.4952584471",
"email": "user@example.art",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"renew"
]
},
{
"type": "string",
"enum": [
"transfer_to_client"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"idn": {
"type": "string",
"enum": [
"пример.art"
],
"description": "Интернационализованное наименование"
},
"name": {
"type": "string",
"enum": [
"xn--e1afmkfd.art"
],
"description": "Наименование"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата окончания срока действия (в формате ISO 8601)"
},
"max_renew": {
"type": "number",
"enum": [
60
],
"description": "Максимально возможный период продления (в месяцах)"
},
"nameservers": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"ns1.example.art"
]
},
{
"type": "string",
"enum": [
"ns2.example.art"
]
}
],
"description": "DNS-сервера"
},
"contact": {
"type": "object",
"properties": {
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"firstname",
"lastname",
"organization",
"phone",
"email",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"_acl",
"id",
"client",
"idn",
"name",
"status",
"created_at",
"updated_at",
"max_renew",
"nameservers",
"contact",
"artwork"
],
"additionalProperties": false
}
Просмотр доменаGET/store/domains/{domain}
- domain
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Домен
Автопродление домена ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Включение автопродленияPUT/store/domains/{domain}/autorenew
- domain
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Домен
Headers
Accept-Language: en
Authorization: Bearer JWT
Выключение автопродленияDELETE/store/domains/{domain}/autorenew
- domain
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Домен
Контакты ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"verified",
"unverified"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"verified"
]
},
{
"type": "string",
"enum": [
"unverified"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов контактаGET/store/contacts/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete",
"verify"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "verified",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"verify"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"status": {
"type": "string",
"enum": [
"verified"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр контактовGET/store/contacts{?client,email,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
string
(optional) Example: user@example.artПочта
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"update",
"delete",
"verify"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "verified",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"verify"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"status": {
"type": "string",
"enum": [
"verified"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false
}
Просмотр контактаGET/store/contacts/{contact}
- contact
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Контакт
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Создание контактаPOST/store/contacts
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Изменение контактаPATCH/store/contacts/{contact}
- contact
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Контакт
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление контактаDELETE/store/contacts/{contact}
- contact
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Контакт
Заказы ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"unpaid",
"processing",
"completed",
"cancelled"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"unpaid"
]
},
{
"type": "string",
"enum": [
"processing"
]
},
{
"type": "string",
"enum": [
"completed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов заказаGET/store/orders/statuses{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"invoice": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "unpaid",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"items": [
{
"service_type": "certificate_registration",
"domain": "example.art",
"promo": "BANANA",
"quantity": 1,
"period": 12,
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"invoice": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Счет"
},
"status": {
"type": "string",
"enum": [
"unpaid"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"quantity": {
"type": "number",
"enum": [
1
],
"description": "Количество"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service_type",
"domain",
"promo",
"quantity",
"period",
"contact",
"artwork"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"_acl",
"id",
"client",
"invoice",
"status",
"created_at",
"updated_at",
"items"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр заказовGET/store/orders{?client,invoice,domain,status,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- invoice
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Счет
- domain
string
(optional) Example: example.artДомен
- status
string
(optional) Example: unpaidСтатус
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"update"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"invoice": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "unpaid",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"items": [
{
"service_type": "certificate_registration",
"domain": "example.art",
"promo": "BANANA",
"quantity": 1,
"period": 12,
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"update"
]
},
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"invoice": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Счет"
},
"status": {
"type": "string",
"enum": [
"unpaid"
],
"description": "Статус"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"quantity": {
"type": "number",
"enum": [
1
],
"description": "Количество"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service_type",
"domain",
"promo",
"quantity",
"period",
"contact",
"artwork"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"_acl",
"id",
"client",
"invoice",
"status",
"created_at",
"updated_at",
"items"
],
"additionalProperties": false
}
Просмотр заказаGET/store/orders/{order}
- order
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заказ
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "certificate_registration",
"domain": "example.art",
"promo": "BANANA",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service_type",
"domain",
"promo",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "certificate_renewal",
"domain": "example.art",
"promo": "BANANA",
"period": 12,
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_renewal"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
}
},
"required": [
"service_type",
"domain",
"promo",
"period",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "domain_reserve",
"domain": "example.art",
"promo": "BANANA",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"domain_reserve"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service_type",
"domain",
"promo",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "nft_minting",
"domain": "example.art",
"promo": "BANANA",
"wallet": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"nft_minting"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"wallet": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
}
},
"required": [
"service_type",
"domain",
"promo",
"wallet",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "domain_attachment",
"domain": "example.art",
"promo": "BANANA",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": "1025462083198052"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"domain_attachment"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "string",
"enum": [
"1025462083198052"
],
"description": "Идентификатор арт-объекта"
}
},
"required": [
"service_type",
"domain",
"promo",
"contact",
"artwork"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Создание заказаPOST/store/orders
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "certificate_registration",
"domain": "example.art",
"promo": "BANANA",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker": "Max Pryakhin",
"type": "Image",
"subject": "DigitalTwin",
"period": "2019",
"dimensions": "1920x1080",
"materials": "Paint",
"markings": "Signed by maker",
"features": "First DigitalTwin artwork",
"reference": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
},
"artwork": {
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"type": {
"type": "string",
"enum": [
"Image"
],
"description": "Тип объекта"
},
"subject": {
"type": "string",
"enum": [
"DigitalTwin"
],
"description": "Тема"
},
"period": {
"type": "string",
"enum": [
"2019"
],
"description": "Дата или период создания"
},
"dimensions": {
"type": "string",
"enum": [
"1920x1080"
],
"description": "Размеры объекта"
},
"materials": {
"type": "string",
"enum": [
"Paint"
],
"description": "Материалы и техника"
},
"markings": {
"type": "string",
"enum": [
"Signed by maker"
],
"description": "Надписи и пометки"
},
"features": {
"type": "string",
"enum": [
"First DigitalTwin artwork"
],
"description": "Особенности"
},
"reference": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Blockchain"
}
},
"required": [
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"service_type",
"domain",
"promo",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "certificate_renewal",
"domain": "example.art",
"promo": "BANANA",
"period": 12,
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
}
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service_type": {
"type": "string",
"enum": [
"certificate_renewal"
],
"description": "Тип услуги"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"promo": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Промо-код"
},
"period": {
"type": "number",
"enum": [
12
],
"description": "Срок действия (в месяцах)"
},
"contact": {
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"ru"
],
"description": "Язык"
},
"firstname": {
"type": "string",
"enum": [
"Max"
],
"description": "Имя"
},
"lastname": {
"type": "string",
"enum": [
"Pryakhin"
],
"description": "Фамилия"
},
"organization": {
"type": "string",
"enum": [
"UKCI Holdings Limited"
],
"description": "Компания"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"phone": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Телефон"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"ethereum": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор Ethereum кошелька"
},
"address": {
"type": "object",
"properties": {
"zip": {
"type": "string",
"enum": [
"119602"
],
"description": "Индекс"
},
"country": {
"type": "string",
"enum": [
"RU"
],
"description": "Страна"
},
"state": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Регион"
},
"city": {
"type": "string",
"enum": [
"Moscow"
],
"description": "Город"
},
"line1": {
"type": "string",
"enum": [
"Akademika Anokhina st."
],
"description": "Строка 1"
},
"line2": {
"type": "string",
"enum": [
"2k7"
],
"description": "Строка 2"
}
},
"required": [
"zip",
"country",
"state",
"city",
"line1",
"line2"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"language",
"firstname",
"lastname",
"organization",
"vat",
"phone",
"email",
"ethereum",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо"
}
},
"required": [
"service_type",
"domain",
"promo",
"period",
"contact"
],
"additionalProperties": false
},
"description": "Позиции заказа"
}
},
"required": [
"items"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"error": "validation_error",
"messages": [
{
"path": "$.field[0].subfield",
"message": "Error description"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"validation_error"
],
"description": "Код ошибки"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"enum": [
"$.field[0].subfield"
],
"description": "Поле (в формате JSONPath)"
},
"message": {
"type": "string",
"enum": [
"Error description"
],
"description": "Сообщение об ошибке"
}
},
"required": [
"message"
],
"additionalProperties": false
},
"description": "Сообщения об ошибках"
}
},
"required": [
"error",
"messages"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"items": [
{
"service_type": "domain_reserve",
"domain": "example.art",
"promo": "BANANA",
"contact": {
"language": "ru",
"firstname": "Max",
"lastname": "Pryakhin",
"organization": "UKCI Holdings Limited",
"vat": "GB004618015",
"phone": "+7.4952584471",
"email": "user@example.art",
"ethereum": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"line1": "Akademika Anokhina st.",
"line2": "2k7"
}
},
"artwork": {
"title": "State of ART",
"maker":