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": "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
{
"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/orders/{order}
- order
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заказ
Headers
Accept-Language: en
Authorization: Bearer JWT
Аннулирование заказаDELETE/store/orders/{order}
- order
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заказ
Headers
Accept-Language: en
Authorization: Bearer JWT
Завершение заказаPOST/store/orders/{order}/complete
- order
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заказ
Промо-коды ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"code": "BANANA",
"type": "percent",
"discount": 33,
"priority": 0,
"description": "33% on all domains",
"short_description": "33% OFF",
"service_type": "certificate_registration",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"standard": true,
"premium": true,
"created_at": "2019-07-25T13:18:46+0000",
"start_at": "2019-07-25T13:18:46+0000",
"expired_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": "Идентификатор"
},
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
},
"type": {
"type": "string",
"enum": [
"percent"
],
"description": "Тип"
},
"discount": {
"type": "number",
"enum": [
33
],
"description": "Размер скидки (процент, сумма в центах)"
},
"priority": {
"type": "number",
"enum": [
0
],
"description": "Приоритет"
},
"description": {
"type": "string",
"enum": [
"33% on all domains"
],
"description": "Описание"
},
"short_description": {
"type": "string",
"enum": [
"33% OFF"
],
"description": "Краткое описание"
},
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"standard": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к стандартным доменам"
},
"premium": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к премиальным доменам"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"start_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)"
}
},
"required": [
"id",
"code",
"type",
"discount",
"priority",
"description",
"short_description",
"service_type",
"client",
"domain",
"standard",
"premium",
"created_at",
"start_at",
"expired_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр промо-кодовGET/store/promo{?code,client,domain,limit,offset}
- code
string
(optional) Example: BANANAПромо-код
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- domain
string
(optional) Example: 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
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"code": "BANANA",
"type": "percent",
"discount": 33,
"priority": 0,
"description": "33% on all domains",
"short_description": "33% OFF",
"service_type": "certificate_registration",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"standard": true,
"premium": true,
"created_at": "2019-07-25T13:18:46+0000",
"start_at": "2019-07-25T13:18:46+0000",
"expired_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": "Идентификатор"
},
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
},
"type": {
"type": "string",
"enum": [
"percent"
],
"description": "Тип"
},
"discount": {
"type": "number",
"enum": [
33
],
"description": "Размер скидки (процент, сумма в центах)"
},
"priority": {
"type": "number",
"enum": [
0
],
"description": "Приоритет"
},
"description": {
"type": "string",
"enum": [
"33% on all domains"
],
"description": "Описание"
},
"short_description": {
"type": "string",
"enum": [
"33% OFF"
],
"description": "Краткое описание"
},
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"standard": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к стандартным доменам"
},
"premium": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к премиальным доменам"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"start_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)"
}
},
"required": [
"id",
"code",
"type",
"discount",
"priority",
"description",
"short_description",
"service_type",
"client",
"domain",
"standard",
"premium",
"created_at",
"start_at",
"expired_at"
],
"additionalProperties": false
}
Просмотр промо-кодаGET/store/promo/{promo}
- promo
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Промо-код
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"code": "BANANA",
"type": "percent",
"discount": 33,
"priority": 0,
"service_type": "certificate_registration",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"standard": true,
"premium": true,
"start_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
},
"type": {
"type": "string",
"enum": [
"percent"
],
"description": "Тип"
},
"discount": {
"type": "number",
"enum": [
33
],
"description": "Размер скидки (процент, сумма в центах)"
},
"priority": {
"type": "number",
"enum": [
0
],
"description": "Приоритет"
},
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"standard": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к стандартным доменам"
},
"premium": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к премиальным доменам"
},
"start_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)"
}
},
"required": [
"code",
"type",
"discount",
"priority",
"service_type",
"client",
"domain",
"standard",
"premium",
"start_at",
"expired_at"
],
"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/promo
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"code": "BANANA",
"type": "percent",
"discount": 33,
"priority": 0,
"service_type": "certificate_registration",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"standard": true,
"premium": true,
"start_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
},
"type": {
"type": "string",
"enum": [
"percent"
],
"description": "Тип"
},
"discount": {
"type": "number",
"enum": [
33
],
"description": "Размер скидки (процент, сумма в центах)"
},
"priority": {
"type": "number",
"enum": [
0
],
"description": "Приоритет"
},
"service_type": {
"type": "string",
"enum": [
"certificate_registration"
],
"description": "Тип услуги"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"standard": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к стандартным доменам"
},
"premium": {
"type": "boolean",
"enum": [
true
],
"description": "Применимость к премиальным доменам"
},
"start_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)"
}
},
"required": [
"code",
"type",
"discount",
"priority",
"service_type",
"client",
"domain",
"standard",
"premium",
"start_at",
"expired_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
}
Изменение промо-кодаPATCH/store/promo/{promo}
- promo
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Промо-код
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"code": "BANANA"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
}
},
"required": [
"code"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"code": "BANANA",
"description": "33% on all domains",
"short_description": "33% OFF"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"code": {
"type": "string",
"enum": [
"BANANA"
],
"description": "Код"
},
"description": {
"type": "string",
"enum": [
"33% on all domains"
],
"description": "Описание"
},
"short_description": {
"type": "string",
"enum": [
"33% OFF"
],
"description": "Краткое описание"
}
},
"required": [
"id",
"code",
"description",
"short_description"
],
"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/promo/check
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление промо-кодаDELETE/store/promo/{promo}
- promo
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Промо-код
Заявки на трансфер доменов ¶
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"domain": "domain.art",
"email": "test@test.art"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Домен, который передается"
},
"email": {
"type": "string",
"description": "Емейл, на которыйредается домен"
}
},
"required": [
"domain",
"email"
]
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Подача заявки на передачу домена пользователюPOST/requests/transfer/to
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"_acl": [
"accept",
"reject",
"cancel"
],
"type": "to",
"domain": "domain.art",
"from": "from@test.art",
"to": "to@test.art",
"created_at": "2019-07-25T13:18:46+0000"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"total": {
"type": "number",
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
]
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Просмотр списка заявокGET/requests/transfer{?client,type,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Идентификатор пользвателя
- type
string
(optional) Example: toТип заявки
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Подтверждение заявкиPUT/requests/transfer/{id}/accept
- id
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заявка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Отклонение заявкиPUT/requests/transfer/{id}/reject
- id
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заявка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Отзыв заявкиPUT/requests/transfer/{id}/cancel
- id
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Заявка
Биллинг ¶
Налоги ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"country": "GB",
"description": "United Kingdom",
"rate": 20,
"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": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"country": {
"type": "string",
"enum": [
"GB"
],
"description": "Страна"
},
"description": {
"type": "string",
"enum": [
"United Kingdom"
],
"description": "Описание"
},
"rate": {
"type": "number",
"enum": [
20
],
"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": [
"_acl",
"id",
"country",
"description",
"rate",
"created_at",
"updated_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр налоговGET/billing/taxes{?country,limit,offset}
- country
string
(optional) Example: RUСтрана
- 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"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"country": "GB",
"description": "United Kingdom",
"rate": 20,
"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": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"country": {
"type": "string",
"enum": [
"GB"
],
"description": "Страна"
},
"description": {
"type": "string",
"enum": [
"United Kingdom"
],
"description": "Описание"
},
"rate": {
"type": "number",
"enum": [
20
],
"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": [
"_acl",
"id",
"country",
"description",
"rate",
"created_at",
"updated_at"
],
"additionalProperties": false
}
Headers
Accept-Language: en
Authorization: Bearer JWT
Body
{
"rate": 20
}
Schema
{
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "Ставка"
}
},
"required": [
"rate"
],
"$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/billing/taxes/{country}
- country
string
(required) Example: RUСтрана
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление налогаDELETE/billing/taxes/{country}
- country
string
(required) Example: RUСтрана
Счета ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"unpaid",
"paid",
"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": [
"paid"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов счетаGET/billing/invoices/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": [
"pay",
"complete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "unpaid",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"vat": "GB004618015",
"payer": [
"Max Pryakhin",
"119602, Moscow",
"Akademika Anokhina st. 2K7",
"Russian Federation"
],
"beneficiary": [
"UKCI Holdings Limited",
"12 Mount Havelock",
"Douglas IM1 2QG",
"Isle of Man",
"EU VAT No: GB004618015"
],
"items": [
{
"description": "Domain Registration - example.art, 3 year/s",
"taxed": true,
"price": {
"amount": 18.99,
"currency": "USD"
}
}
],
"subtotal": {
"amount": 18.99,
"currency": "USD"
},
"discount": {
"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": {
"total": {
"type": "number",
"enum": [
123
],
"description": "Общее количество элементов, удовлетворяющих параметрам запроса"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"pay"
]
},
{
"type": "string",
"enum": [
"complete"
]
}
],
"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": [
"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)"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"payer": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"Max Pryakhin"
]
},
{
"type": "string",
"enum": [
"119602, Moscow"
]
},
{
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
]
},
{
"type": "string",
"enum": [
"Russian Federation"
]
}
],
"description": "Данные плательщика"
},
"beneficiary": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"UKCI Holdings Limited"
]
},
{
"type": "string",
"enum": [
"12 Mount Havelock"
]
},
{
"type": "string",
"enum": [
"Douglas IM1 2QG"
]
},
{
"type": "string",
"enum": [
"Isle of Man"
]
},
{
"type": "string",
"enum": [
"EU VAT No: GB004618015"
]
}
],
"description": "Данные получателя"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Domain Registration - example.art, 3 year/s"
],
"description": "Описание"
},
"taxed": {
"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": "Цена за единицу"
}
},
"required": [
"description",
"taxed",
"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": "Цена без НДС"
},
"discount": {
"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": "Итоговая цена"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"vat",
"payer",
"beneficiary",
"items",
"subtotal",
"discount",
"tax",
"total"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр счетовGET/billing/invoices{?client,status,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- 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": [
"pay",
"complete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"status": "unpaid",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"vat": "GB004618015",
"payer": [
"Max Pryakhin",
"119602, Moscow",
"Akademika Anokhina st. 2K7",
"Russian Federation"
],
"beneficiary": [
"UKCI Holdings Limited",
"12 Mount Havelock",
"Douglas IM1 2QG",
"Isle of Man",
"EU VAT No: GB004618015"
],
"items": [
{
"description": "Domain Registration - example.art, 3 year/s",
"taxed": true,
"price": {
"amount": 18.99,
"currency": "USD"
}
}
],
"subtotal": {
"amount": 18.99,
"currency": "USD"
},
"discount": {
"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"
]
},
{
"type": "string",
"enum": [
"complete"
]
}
],
"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": [
"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)"
},
"vat": {
"type": "string",
"enum": [
"GB004618015"
],
"description": "VAT"
},
"payer": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"Max Pryakhin"
]
},
{
"type": "string",
"enum": [
"119602, Moscow"
]
},
{
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
]
},
{
"type": "string",
"enum": [
"Russian Federation"
]
}
],
"description": "Данные плательщика"
},
"beneficiary": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"UKCI Holdings Limited"
]
},
{
"type": "string",
"enum": [
"12 Mount Havelock"
]
},
{
"type": "string",
"enum": [
"Douglas IM1 2QG"
]
},
{
"type": "string",
"enum": [
"Isle of Man"
]
},
{
"type": "string",
"enum": [
"EU VAT No: GB004618015"
]
}
],
"description": "Данные получателя"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"enum": [
"Domain Registration - example.art, 3 year/s"
],
"description": "Описание"
},
"taxed": {
"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": "Цена за единицу"
}
},
"required": [
"description",
"taxed",
"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": "Цена без НДС"
},
"discount": {
"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": "Итоговая цена"
}
},
"required": [
"_acl",
"id",
"client",
"status",
"created_at",
"updated_at",
"vat",
"payer",
"beneficiary",
"items",
"subtotal",
"discount",
"tax",
"total"
],
"additionalProperties": false
}
Просмотр счетаGET/billing/invoices/{invoice}
- invoice
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Счет
Headers
Accept-Language: en
Authorization: Bearer JWT
Закрытие счетаPUT/billing/invoices/{invoice}/complete
- invoice
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Счет
Платежи Bluesnap ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"url": "https://ws.bluesnap.com"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://ws.bluesnap.com"
],
"description": "URL Bluesnap"
}
},
"required": [
"url"
],
"additionalProperties": false
}
Просмотр URLGET/billing/bluesnap/url
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"invoices": [
"59507894-1939-4b16-8a77-3e664c0eb257"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
]
},
"description": "Счета"
}
},
"required": [
"invoices"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"payment": "59507894-1939-4b16-8a77-3e664c0eb257",
"token": "e0861c68cf055737aecd470ab35d7b80ed7b4c8d4a259ac6807f176f19b78634_"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Платеж"
},
"token": {
"type": "string",
"enum": [
"e0861c68cf055737aecd470ab35d7b80ed7b4c8d4a259ac6807f176f19b78634_"
],
"description": "Токен Bluesnap"
}
},
"required": [
"payment",
"token"
],
"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/billing/bluesnap
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"card": "123456"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"card": {
"type": "string",
"enum": [
"123456"
],
"description": "Первые 6 цифр карты (ccBin)"
}
},
"required": [
"card"
],
"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/billing/bluesnap/{payment}/process
- payment
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Платеж
Подписки Bluesnap ¶
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"create",
"update",
"delete",
"view"
],
"id": "7ea33ab4-91f7-41a3-93ac-c954bb70d973",
"subscription_id": "30727479",
"card_last_four": "1111",
"card_month": "07",
"card_year": "2023",
"is_active": true
}
]
}
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": [
"create"
]
},
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"view"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"7ea33ab4-91f7-41a3-93ac-c954bb70d973"
],
"description": "Идентификатор"
},
"subscription_id": {
"type": "string",
"enum": [
"30727479"
],
"description": "Идентификатор подписки в Bluesnap"
},
"card_last_four": {
"type": "string",
"enum": [
"1111"
],
"description": "Последние 4 цифры карты"
},
"card_month": {
"type": "string",
"enum": [
"07"
],
"description": "Месяц"
},
"card_year": {
"type": "string",
"enum": [
"2023"
],
"description": "Год"
},
"is_active": {
"type": "boolean",
"enum": [
true
],
"description": "Активный"
}
},
"required": [
"_acl",
"id",
"subscription_id",
"card_last_four",
"card_month",
"card_year"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр подписокGET/billing/bluesnap/subscriptions{?client,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"create",
"update",
"delete",
"view"
],
"id": "7ea33ab4-91f7-41a3-93ac-c954bb70d973",
"subscription_id": "30727479",
"card_last_four": "1111",
"card_month": "07",
"card_year": "2023",
"is_active": true
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"create"
]
},
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"view"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"7ea33ab4-91f7-41a3-93ac-c954bb70d973"
],
"description": "Идентификатор"
},
"subscription_id": {
"type": "string",
"enum": [
"30727479"
],
"description": "Идентификатор подписки в Bluesnap"
},
"card_last_four": {
"type": "string",
"enum": [
"1111"
],
"description": "Последние 4 цифры карты"
},
"card_month": {
"type": "string",
"enum": [
"07"
],
"description": "Месяц"
},
"card_year": {
"type": "string",
"enum": [
"2023"
],
"description": "Год"
},
"is_active": {
"type": "boolean",
"enum": [
true
],
"description": "Активный"
}
},
"required": [
"_acl",
"id",
"subscription_id",
"card_last_four",
"card_month",
"card_year"
],
"additionalProperties": false
}
Просмотр подпискиGET/billing/bluesnap/subscriptions/{subscription}
- subscription
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"
}
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
Accept-Language: en
Authorization: Bearer JWT
Body
{
"payment": "29eb915c-5841-42b1-add9-d42e080ec172"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment": {
"type": "string",
"description": "Платеж"
}
},
"required": [
"payment"
]
}
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
}
Создание подпискиPOST/billing/bluesnap/subscriptions
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Обновление подпискиPUT/billing/bluesnap/subscriptions/{subscription}
- subscription
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Подписка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление подпискиDELETE/billing/bluesnap/subscriptions/{subscription}
- subscription
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
{
"token": "e0861c68cf055737aecd470ab35d7b80ed7b4c8d4a259ac6807f176f19b78634_"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Токен Bluesnap"
}
},
"required": [
"token"
]
}
Генерация токенаGET/billing/bluesnap/subscriptions/token
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"token": "e0861c68cf055737aecd470ab35d7b80ed7b4c8d4a259ac6807f176f19b78634_"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Токен Bluesnap"
}
},
"required": [
"token"
]
}
Генерация токена подпискиGET/billing/bluesnap/subscriptions/{subscription}/token
- subscription
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Подписка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"payment": "29eb915c-5841-42b1-add9-d42e080ec172"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"payment": {
"type": "string",
"description": "Платеж"
}
},
"required": [
"payment"
]
}
Проведение платежа по подпискеPUT/billing/bluesnap/subscriptions/{subscription}/process
- subscription
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Подписка
Реестр арт-объектов ¶
Арт-объекты ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"published",
"unpublished",
"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": [
"published"
]
},
{
"type": "string",
"enum": [
"unpublished"
]
},
{
"type": "string",
"enum": [
"unregistered"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов арт-объектаGET/artworks/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",
"publish",
"unpublish",
"donate",
"mint_nft",
"renew",
"transfer_to_client",
"attach_domain",
"enable_autorenew",
"disable_autorenew"
],
"id": "1024688430153904",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"certificate_domain": "1025106196959682.ip.art",
"status": "published",
"nft": [
{
"type": "opensea",
"link": "https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
}
],
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"expired": false,
"title": "State of ART",
"maker": "Max Pryakhin",
"original_title": "State of ART",
"original_maker": "Max Pryakhin",
"preview": "https://static.art.art/previews/image.jpg"
}
]
}
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": [
"publish"
]
},
{
"type": "string",
"enum": [
"unpublish"
]
},
{
"type": "string",
"enum": [
"donate"
]
},
{
"type": "string",
"enum": [
"mint_nft"
]
},
{
"type": "string",
"enum": [
"renew"
]
},
{
"type": "string",
"enum": [
"transfer_to_client"
]
},
{
"type": "string",
"enum": [
"attach_domain"
]
},
{
"type": "string",
"enum": [
"enable_autorenew"
]
},
{
"type": "string",
"enum": [
"disable_autorenew"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"certificate_domain": {
"type": "string",
"enum": [
"1025106196959682.ip.art"
],
"description": "Домен сертификата"
},
"status": {
"type": "string",
"enum": [
"published"
],
"description": "Статус"
},
"nft": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"opensea",
"rarible"
],
"description": "Тип ссылки"
},
"link": {
"type": "string",
"enum": [
"https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
],
"description": "Ссылка на NFT"
}
},
"required": [
"type",
"link"
],
"additionalProperties": false
},
"description": "Список ссылок на NFT сертификата"
},
"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",
"null"
],
"enum": [
"2019-07-25T13:18:46+0000",
null
],
"description": "Дата истечения сертификата (в формате ISO 8601)"
},
"expired": {
"type": [
"boolean",
"null"
],
"enum": [
false,
null
],
"description": "Просрочен ли домен"
},
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"original_title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название на языке оригинала"
},
"original_maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор на языке оригинала"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/image.jpg"
],
"description": "URL предпросмотра"
}
},
"required": [
"_acl",
"id",
"client",
"domain",
"certificate_domain",
"status",
"nft",
"created_at",
"updated_at",
"expired_at",
"expired",
"title",
"maker",
"original_title",
"original_maker"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр арт-объектовGET/artworks{?client,domain,status,public,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- domain
string
(optional) Example: example.artДомен
- status
string
(optional) Example: publishedСтатус
- public
boolean
(optional) Example: trueПубликация
- 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",
"publish",
"unpublish",
"donate",
"mint_nft",
"renew",
"transfer_to_client",
"attach_domain",
"enable_autorenew",
"disable_autorenew"
],
"id": "1024688430153904",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"certificate_domain": "1025106196959682.ip.art",
"status": "published",
"nft": [
{
"type": "opensea",
"link": "https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
}
],
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"expired": false,
"title": "State of ART",
"maker": "Max Pryakhin",
"original_title": "State of ART",
"original_maker": "Max Pryakhin",
"preview": "https://static.art.art/previews/image.jpg"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"publish"
]
},
{
"type": "string",
"enum": [
"unpublish"
]
},
{
"type": "string",
"enum": [
"donate"
]
},
{
"type": "string",
"enum": [
"mint_nft"
]
},
{
"type": "string",
"enum": [
"renew"
]
},
{
"type": "string",
"enum": [
"transfer_to_client"
]
},
{
"type": "string",
"enum": [
"attach_domain"
]
},
{
"type": "string",
"enum": [
"enable_autorenew"
]
},
{
"type": "string",
"enum": [
"disable_autorenew"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"certificate_domain": {
"type": "string",
"enum": [
"1025106196959682.ip.art"
],
"description": "Домен сертификата"
},
"status": {
"type": "string",
"enum": [
"published"
],
"description": "Статус"
},
"nft": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"opensea",
"rarible"
],
"description": "Тип ссылки"
},
"link": {
"type": "string",
"enum": [
"https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
],
"description": "Ссылка на NFT"
}
},
"required": [
"type",
"link"
],
"additionalProperties": false
},
"description": "Список ссылок на NFT сертификата"
},
"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",
"null"
],
"enum": [
"2019-07-25T13:18:46+0000",
null
],
"description": "Дата истечения сертификата (в формате ISO 8601)"
},
"expired": {
"type": [
"boolean",
"null"
],
"enum": [
false,
null
],
"description": "Просрочен ли домен"
},
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"original_title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название на языке оригинала"
},
"original_maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор на языке оригинала"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/image.jpg"
],
"description": "URL предпросмотра"
}
},
"required": [
"_acl",
"id",
"client",
"domain",
"certificate_domain",
"status",
"nft",
"created_at",
"updated_at",
"expired_at",
"expired",
"title",
"maker",
"original_title",
"original_maker"
],
"additionalProperties": false
}
Просмотр арт-объектаGET/artworks/{artwork}
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"url": "https://static.art.art/certificates/1024688430153904.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://static.art.art/certificates/1024688430153904.pdf"
],
"description": "URL сертификата"
}
},
"additionalProperties": false
}
Просмотр сертификатаGET/artworks/{artwork}/certificate
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Accept-Language: en
Authorization: Bearer JWT
Публикация арт-объектаPUT/artworks/{artwork}/public
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Accept-Language: en
Authorization: Bearer JWT
Снятие с публикацииDELETE/artworks/{artwork}/public
- artwork
string
(required) Example: 1024688430153904Арт-объект
Переводы ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
"published",
"unpublished",
"processing"
]
}
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": [
"published"
]
},
{
"type": "string",
"enum": [
"unpublished"
]
},
{
"type": "string",
"enum": [
"processing"
]
}
],
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статусов переводаGET/artworks/{artwork}/translations/statuses{?limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- 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",
"update_artrecords",
"delete",
"publish",
"unpublish"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"status": "published",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"primary": true,
"original": true,
"language": "English",
"owner": "Max Pryakhin",
"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",
"description": "State of ART is the first DigitalTwin artwork"
}
]
}
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": [
"update_artrecords"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"publish"
]
},
{
"type": "string",
"enum": [
"unpublish"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"status": {
"type": "string",
"enum": [
"published"
],
"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)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основной язык"
},
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"owner": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Владелец"
},
"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"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"_acl",
"id",
"artwork",
"status",
"created_at",
"updated_at",
"primary",
"original",
"language",
"owner",
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference",
"description"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр переводовGET/artworks/{artwork}/translations{?primary,original,status,limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- primary
boolean
(optional) Example: trueОсновной язык
- original
boolean
(optional) Example: trueЯзык оригинала
- status
string
(optional) Example: publishedСтатус
- 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",
"update_artrecords",
"delete",
"publish",
"unpublish"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"status": "published",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"primary": true,
"original": true,
"language": "English",
"owner": "Max Pryakhin",
"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",
"description": "State of ART is the first DigitalTwin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"update_artrecords"
]
},
{
"type": "string",
"enum": [
"delete"
]
},
{
"type": "string",
"enum": [
"publish"
]
},
{
"type": "string",
"enum": [
"unpublish"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"status": {
"type": "string",
"enum": [
"published"
],
"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)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основной язык"
},
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"owner": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Владелец"
},
"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"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"_acl",
"id",
"artwork",
"status",
"created_at",
"updated_at",
"primary",
"original",
"language",
"owner",
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference",
"description"
],
"additionalProperties": false
}
Просмотр переводаGET/artworks/{artwork}/translations/{translation}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- translation
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Перевод
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"original": true,
"language": "English",
"owner": "Max Pryakhin",
"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",
"description": "State of ART is the first DigitalTwin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"owner": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Владелец"
},
"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"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"original",
"language",
"owner",
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference",
"description"
],
"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/artworks/{artwork}/translations
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"original": true,
"language": "English",
"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",
"description": "State of ART is the first DigitalTwin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"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"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"original",
"language",
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference",
"description"
],
"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
{
"original": true,
"language": "English",
"description": "State of ART is the first DigitalTwin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"original",
"language",
"description"
],
"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
{
"original": true,
"language": "English",
"owner": "Max Pryakhin",
"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",
"description": "State of ART is the first DigitalTwin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"original": {
"type": "boolean",
"enum": [
true
],
"description": "Язык оригинала"
},
"language": {
"type": "string",
"enum": [
"English"
],
"description": "Язык"
},
"owner": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Владелец"
},
"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"
},
"description": {
"type": "string",
"enum": [
"State of ART is the first DigitalTwin artwork"
],
"description": "Описание"
}
},
"required": [
"original",
"language",
"owner",
"title",
"maker",
"type",
"subject",
"period",
"dimensions",
"materials",
"markings",
"features",
"reference",
"description"
],
"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/artworks/{artwork}/translations/{translation}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- translation
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Перевод
Headers
Accept-Language: en
Authorization: Bearer JWT
Публикация переводаPUT/artworks/{artwork}/translations/{translation}/public
- artwork
string
(required) Example: 1024688430153904Арт-объект
- translation
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Перевод
Headers
Accept-Language: en
Authorization: Bearer JWT
Снятие с публикацииDELETE/artworks/{artwork}/translations/{translation}/public
- artwork
string
(required) Example: 1024688430153904Арт-объект
- translation
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Перевод
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление переводаDELETE/artworks/{artwork}/translations/{translation}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- translation
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Перевод
Изображения ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"primary": true,
"preview": "https://static.art.art/previews/image.jpg",
"url": "https://static.art.art/images/image.jpg"
}
]
}
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"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основное изображение"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/image.jpg"
],
"description": "URL предпросмотра"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/images/image.jpg"
],
"description": "URL изображения"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"primary"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр изображенийGET/artworks/{artwork}/images{?primary,limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- primary
boolean
(optional) Example: trueОсновное изображение
- 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"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"primary": true,
"preview": "https://static.art.art/previews/image.jpg",
"url": "https://static.art.art/images/image.jpg"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основное изображение"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/image.jpg"
],
"description": "URL предпросмотра"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/images/image.jpg"
],
"description": "URL изображения"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"primary"
],
"additionalProperties": false
}
Просмотр изображенияGET/artworks/{artwork}/images/{image}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- image
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Изображение
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"preview": "https://static.art.art/uploads/preview.jpg",
"url": "https://static.art.art/uploads/image.jpg"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"preview": {
"type": "string",
"enum": [
"https://static.art.art/uploads/preview.jpg"
],
"description": "URL предпросмотра"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/uploads/image.jpg"
],
"description": "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/artworks/{artwork}/images
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление изображенияDELETE/artworks/{artwork}/images/{image}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- image
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Изображение
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Установка изображения основнымPUT/artworks/{artwork}/images/{image}/primary
- artwork
string
(required) Example: 1024688430153904Арт-объект
- image
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Изображение
Видео ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"primary": true,
"title": "Video explanation of DigitalTwin artwork",
"preview": "https://static.art.art/previews/video.jpg",
"url": "https://static.art.art/videos/video.avi"
}
]
}
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"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основной ролик"
},
"title": {
"type": "string",
"enum": [
"Video explanation of DigitalTwin artwork"
],
"description": "Заголовок видео"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/video.jpg"
],
"description": "URL предпросмотра"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/videos/video.avi"
],
"description": "URL видео"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"primary",
"title"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр роликовGET/artworks/{artwork}/videos{?primary,limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- primary
boolean
(optional) Example: trueОсновной ролик
- 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"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"primary": true,
"title": "Video explanation of DigitalTwin artwork",
"preview": "https://static.art.art/previews/video.jpg",
"url": "https://static.art.art/videos/video.avi"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"primary": {
"type": "boolean",
"enum": [
true
],
"description": "Основной ролик"
},
"title": {
"type": "string",
"enum": [
"Video explanation of DigitalTwin artwork"
],
"description": "Заголовок видео"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/video.jpg"
],
"description": "URL предпросмотра"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/videos/video.avi"
],
"description": "URL видео"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"primary",
"title"
],
"additionalProperties": false
}
Просмотр роликаGET/artworks/{artwork}/videos/{video}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- video
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Видео
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"url": "https://static.art.art/videos/video.avi"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://static.art.art/videos/video.avi"
],
"description": "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/artworks/{artwork}/videos
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление роликаDELETE/artworks/{artwork}/videos/{video}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- video
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Видео
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"title": "Video explanation of DigitalTwin artwork",
"preview": "https://static.art.art/previews/video.avi"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"Video explanation of DigitalTwin artwork"
],
"description": "Заголовок видео"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/video.avi"
],
"description": "URL предпросмотра"
}
},
"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/artworks/{artwork}/videos/{video}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- video
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Видео
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Установка ролика основнымPUT/artworks/{artwork}/videos/{video}/primary
- artwork
string
(required) Example: 1024688430153904Арт-объект
- video
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Ролик
Файлы ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"title": "Beautiful presentation of Digital Twin artwork",
"url": "https://static.art.art/files/file.pdf"
}
]
}
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"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"title": {
"type": "string",
"enum": [
"Beautiful presentation of Digital Twin artwork"
],
"description": "Название файла"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/files/file.pdf"
],
"description": "URL файла"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"title"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр файловGET/artworks/{artwork}/files{?limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- 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"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"artwork": "1024688430153904",
"created_at": "2019-07-25T13:18:46+0000",
"title": "Beautiful presentation of Digital Twin artwork",
"url": "https://static.art.art/files/file.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"artwork": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Арт-объект"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"title": {
"type": "string",
"enum": [
"Beautiful presentation of Digital Twin artwork"
],
"description": "Название файла"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/files/file.pdf"
],
"description": "URL файла"
}
},
"required": [
"_acl",
"id",
"artwork",
"created_at",
"title"
],
"additionalProperties": false
}
Просмотр файлаGET/artworks/{artwork}/files/{file}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"url": "https://static.art.art/uploads/file.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string",
"enum": [
"https://static.art.art/uploads/file.pdf"
],
"description": "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/artworks/{artwork}/files
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"title": "Beautiful presentation of Digital Twin artwork"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"title": {
"type": "string",
"enum": [
"Beautiful presentation of Digital Twin artwork"
],
"description": "Название файла"
}
},
"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/artworks/{artwork}/files/{file}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление файлаDELETE/artworks/{artwork}/files/{file}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Загрузки ¶
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"name": "test.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"test.pdf"
],
"description": "Оригинальное имя файла"
}
},
"required": [
"name"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"complete"
]
},
{
"type": "string",
"enum": [
"delete"
]
}
],
"description": "Права доступа"
},
"status": {
"type": "string",
"enum": [
"processing"
],
"description": "Статус"
},
"artwork": {
"type": "string",
"enum": [
"1025468818635797"
],
"description": "Арт-объект"
},
"file": {
"type": "string",
"enum": [
"95b7843e-07dd-4e30-b982-4d4861dbf6c1"
],
"description": "Файл"
},
"name": {
"type": "string",
"enum": [
"test.pdf"
],
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"enum": [
"https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf"
],
"description": "URL файла"
},
"upload": {
"type": "string",
"enum": [
"https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3"
],
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"enum": [
"2021-05-11T10:58:37+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"enum": [
"2021-05-11T11:18:37+0000"
],
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_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/artworks/{artwork}/presigned/image
- artwork
string
(required) Example: 1025468818635797Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"name": "test.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"test.pdf"
],
"description": "Оригинальное имя файла"
}
},
"required": [
"name"
],
"additionalProperties": false
}
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string"
},
"description": "Права доступа"
},
"status": {
"type": "string",
"description": "Статус"
},
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"file": {
"type": "string",
"description": "Файл"
},
"name": {
"type": "string",
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"description": "URL файла"
},
"upload": {
"type": "string",
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_at"
],
"$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
}
Получение подписанной ссылки для загрузки видеоPOST/artworks/{artwork}/presigned/video
- artwork
string
(required) Example: 1025468818635797Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"name": "test.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"test.pdf"
],
"description": "Оригинальное имя файла"
}
},
"required": [
"name"
],
"additionalProperties": false
}
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string"
},
"description": "Права доступа"
},
"status": {
"type": "string",
"description": "Статус"
},
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"file": {
"type": "string",
"description": "Файл"
},
"name": {
"type": "string",
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"description": "URL файла"
},
"upload": {
"type": "string",
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_at"
],
"$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
}
Получение подписанной ссылки для загрузки документаPOST/artworks/{artwork}/presigned/editorial
- artwork
string
(required) Example: 1025468818635797Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string"
},
"description": "Права доступа"
},
"status": {
"type": "string",
"description": "Статус"
},
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"file": {
"type": "string",
"description": "Файл"
},
"name": {
"type": "string",
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"description": "URL файла"
},
"upload": {
"type": "string",
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_at"
],
"$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
}
Подтверждение загрузки изображенияPOST/artworks/{artwork}/presigned/image/{file}/complete
- artwork
string
(required) Example: 1025468818635797Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string"
},
"description": "Права доступа"
},
"status": {
"type": "string",
"description": "Статус"
},
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"file": {
"type": "string",
"description": "Файл"
},
"name": {
"type": "string",
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"description": "URL файла"
},
"upload": {
"type": "string",
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_at"
],
"$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
}
Подтверждение загрузки видеоPOST/artworks/{artwork}/presigned/video/{file}/complete
- artwork
string
(required) Example: 1025468818635797Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"_acl": [
"complete",
"delete"
],
"status": "processing",
"artwork": "1025468818635797",
"file": "95b7843e-07dd-4e30-b982-4d4861dbf6c1",
"name": "test.pdf",
"url": "https://userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf",
"upload": "https://s3.us-west-2.amazonaws.com/userdata.ip.art/1025468818635797/b6fdc43c-1f4f-41f7-94c3-11acc5b81bcb.pdf?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=userdata.ip.art%2F20210511%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210511T105837Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1200&X-Amz-Signature=1f4e607eb2dde0a7ff5ba296cd21a70635e73ea1e2613ab8436d4ea1317cf3f3",
"created_at": "2021-05-11T10:58:37+0000",
"expired_at": "2021-05-11T11:18:37+0000"
}
Schema
{
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string"
},
"description": "Права доступа"
},
"status": {
"type": "string",
"description": "Статус"
},
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"file": {
"type": "string",
"description": "Файл"
},
"name": {
"type": "string",
"description": "Оригинальное имя файла"
},
"url": {
"type": "string",
"description": "URL файла"
},
"upload": {
"type": "string",
"description": "Подписанная ссылка на закачку файла"
},
"created_at": {
"type": "string",
"description": "Дата создания (в формате ISO 8601)"
},
"expired_at": {
"type": "string",
"description": "Дата окончания срока действия ссылки на закачку (в формате ISO 8601)"
}
},
"required": [
"_acl",
"status",
"artwork",
"file",
"name",
"url",
"upload",
"created_at",
"expired_at"
],
"$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
}
Подтверждение загрузки документаPOST/artworks/{artwork}/presigned/editorial/{file}/complete
- artwork
string
(required) Example: 1025468818635797Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление загрузкиDELETE/artworks/{artwork}/presigned/{file}
- artwork
string
(required) Example: 1025468818635797Арт-объект
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Социальные сети ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"type": "facebook",
"link": "https://facebook.com/profile/59507894-1939-4b16-8a77-3e664c0eb257"
}
]
}
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": {
"type": {
"type": "string",
"enum": [
"facebook"
],
"description": "Тип социальной сети"
},
"link": {
"type": "string",
"enum": [
"https://facebook.com/profile/59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "URL социальной сети"
}
},
"required": [
"type"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр социальных сетейGET/artworks/{artwork}/socials
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
[
{
"type": "facebook",
"link": "https://facebook.com/profile/59507894-1939-4b16-8a77-3e664c0eb257"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"facebook"
],
"description": "Тип социальной сети"
},
"link": {
"type": "string",
"enum": [
"https://facebook.com/profile/59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "URL социальной сети"
}
},
"required": [
"type"
],
"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/artworks/{artwork}/socials
- artwork
string
(required) Example: 1024688430153904Арт-объект
Пожертвования ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"name": "Max Pryakhin",
"email": "user@example.art",
"funds": {
"amount": 18.99,
"currency": "USD"
},
"status": "read",
"created_at": "2019-07-25T13:18:46+0000"
}
],
"active": true,
"total_funds": {
"amount": 18.99,
"currency": "USD"
}
}
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": "Идентификатор"
},
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя пожертвовающего"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта пожертвовающего"
},
"funds": {
"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": [
"read"
],
"description": "Статус пожертвования"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
}
},
"required": [
"id",
"name",
"email",
"funds",
"status",
"created_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
},
"active": {
"type": "boolean",
"enum": [
true
],
"description": "Включены ли пожертвования"
},
"total_funds": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Общая сумма пожертвований"
}
},
"required": [
"total",
"items",
"active",
"total_funds"
],
"additionalProperties": false
}
Просмотр пожертвованийGET/artworks/{artwork}/donations{?limit,offset,from}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
- from
string
(optional) Example: 2019-07-25T13:18:46ZНачало периода
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"valid_at": "2019-07-25T13:18:46+0000",
"funds": {
"amount": 18.99,
"currency": "USD"
}
}
]
}
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": {
"valid_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата формирования"
},
"funds": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Сумма пожертвования"
}
},
"required": [
"valid_at",
"funds"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статистики по днямGET/artworks/{artwork}/donations/statistics/days{?from}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- from
string
(optional) Example: 2019-07-25T13:18:46ZНачало периода
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"valid_at": "2019-07-25T13:18:46+0000",
"funds": {
"amount": 18.99,
"currency": "USD"
}
}
]
}
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": {
"valid_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата формирования"
},
"funds": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"enum": [
18.99
],
"description": "Сумма"
},
"currency": {
"type": "string",
"enum": [
"USD"
],
"description": "Валюта"
}
},
"required": [
"amount",
"currency"
],
"additionalProperties": false,
"description": "Сумма пожертвования"
}
},
"required": [
"valid_at",
"funds"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр статистики по месяцамGET/artworks/{artwork}/donations/statistics/months{?from}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- from
string
(optional) Example: 2019-07-25T13:18:46ZНачало периода
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"email": "user@example.art"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
}
},
"required": [
"email"
],
"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/artworks/{artwork}/donations/transfer
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Включение пожертвованийPUT/artworks/{artwork}/donations/active
- artwork
string
(required) Example: 1024688430153904Арт-объект
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Выключение пожертвованийDELETE/artworks/{artwork}/donations/active
- artwork
string
(required) Example: 1024688430153904Арт-объект
История ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"title": "Certificate Issuer",
"value": "UK Creative Ideas Limited",
"previous": "Max Pryakhin",
"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": "Идентификатор"
},
"title": {
"type": "string",
"enum": [
"Certificate Issuer"
],
"description": "Название поля"
},
"value": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Значение"
},
"previous": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Предыдущее значение"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"title",
"value",
"previous",
"updated_at"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр историиGET/artworks/{artwork}/history{?limit,offset}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- 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",
"title": "Certificate Issuer",
"value": "UK Creative Ideas Limited",
"previous": "Max Pryakhin",
"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": "Идентификатор"
},
"title": {
"type": "string",
"enum": [
"Certificate Issuer"
],
"description": "Название поля"
},
"value": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Значение"
},
"previous": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Предыдущее значение"
},
"updated_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата изменения (в формате ISO 8601)"
}
},
"required": [
"id",
"title",
"value",
"previous",
"updated_at"
],
"additionalProperties": false
}
Просмотр записиGET/artworks/{artwork}/history/{item}
- artwork
string
(required) Example: 1024688430153904Арт-объект
- item
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Запись истории
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"snapshot": "8f9ca982-e91c-11e9-8a6f-94659cbe745e",
"domain": "example.art",
"status": "active",
"valid_at": "2019-07-25T13:18:46+0000",
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"deleted_at": "2019-07-25T13:18:46+0000",
"nameservers": [
"ns1.example.art",
"ns2.example.art"
],
"registrant": {
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited",
"email": "user@example.art",
"phone": {
"number": "+7.4952584471",
"ext": "0000"
},
"fax": {
"number": "+7.4952584471",
"ext": "0000"
},
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"street": "Akademika Anokhina st. 2K7"
}
},
"admin": {
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited",
"email": "user@example.art",
"phone": {
"number": "+7.4952584471",
"ext": "0000"
},
"fax": {
"number": "+7.4952584471",
"ext": "0000"
},
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"street": "Akademika Anokhina st. 2K7"
}
},
"tech": {
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited",
"email": "user@example.art",
"phone": {
"number": "+7.4952584471",
"ext": "0000"
},
"fax": {
"number": "+7.4952584471",
"ext": "0000"
},
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"street": "Akademika Anokhina st. 2K7"
}
},
"billing": {
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited",
"email": "user@example.art",
"phone": {
"number": "+7.4952584471",
"ext": "0000"
},
"fax": {
"number": "+7.4952584471",
"ext": "0000"
},
"address": {
"zip": "119602",
"country": "RU",
"state": "Moscow",
"city": "Moscow",
"street": "Akademika Anokhina st. 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": {
"snapshot": {
"type": "string",
"enum": [
"8f9ca982-e91c-11e9-8a6f-94659cbe745e"
],
"description": "Снимок состояния домена"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"status": {
"type": "string",
"enum": [
"active"
],
"description": "Статус домена"
},
"valid_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания снимка (в формате ISO 8601)"
},
"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)"
},
"deleted_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата удаления домена (в формате ISO 8601)"
},
"nameservers": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"ns1.example.art"
]
},
{
"type": "string",
"enum": [
"ns2.example.art"
]
}
],
"description": "DNS-сервера"
},
"registrant": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"description": "Телефон"
},
"fax": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"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": "Город"
},
"street": {
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
],
"description": "Улица"
}
},
"required": [
"zip",
"country",
"state",
"city",
"street"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"name",
"organization",
"email",
"phone",
"fax",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо по вопросам регистрации домена"
},
"admin": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"description": "Телефон"
},
"fax": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"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": "Город"
},
"street": {
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
],
"description": "Улица"
}
},
"required": [
"zip",
"country",
"state",
"city",
"street"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"name",
"organization",
"email",
"phone",
"fax",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо по административным вопросам"
},
"tech": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"description": "Телефон"
},
"fax": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"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": "Город"
},
"street": {
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
],
"description": "Улица"
}
},
"required": [
"zip",
"country",
"state",
"city",
"street"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"name",
"organization",
"email",
"phone",
"fax",
"address"
],
"additionalProperties": false,
"description": "Контактное лицо по техническим вопросам"
},
"billing": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
},
"email": {
"type": "string",
"enum": [
"user@example.art"
],
"description": "Почта"
},
"phone": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"description": "Телефон"
},
"fax": {
"type": "object",
"properties": {
"number": {
"type": "string",
"enum": [
"+7.4952584471"
],
"description": "Номер"
},
"ext": {
"type": "string",
"enum": [
"0000"
],
"description": "Добавочный номер"
}
},
"required": [
"number",
"ext"
],
"additionalProperties": false,
"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": "Город"
},
"street": {
"type": "string",
"enum": [
"Akademika Anokhina st. 2K7"
],
"description": "Улица"
}
},
"required": [
"zip",
"country",
"state",
"city",
"street"
],
"additionalProperties": false,
"description": "Адрес"
}
},
"required": [
"name",
"organization",
"email",
"phone",
"fax",
"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": [
"snapshot",
"domain",
"status",
"valid_at",
"created_at",
"updated_at",
"expired_at",
"deleted_at",
"nameservers",
"registrant",
"admin",
"tech",
"billing",
"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/artworks/snapshots
Галерея арт-объектов ¶
Галерея ¶
Headers
Accept-Language: en
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"update",
"delete"
],
"id": "7ea33ab4-91f7-41a3-93ac-c954bb70d973",
"priority": 0,
"artwork": {
"_acl": [
"update",
"publish",
"unpublish",
"donate",
"mint_nft",
"renew",
"transfer_to_client",
"attach_domain",
"enable_autorenew",
"disable_autorenew"
],
"id": "1024688430153904",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"domain": "example.art",
"certificate_domain": "1025106196959682.ip.art",
"status": "published",
"nft": [
{
"type": "opensea",
"link": "https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
}
],
"created_at": "2019-07-25T13:18:46+0000",
"updated_at": "2019-07-25T13:18:46+0000",
"expired_at": "2019-07-25T13:18:46+0000",
"expired": false,
"title": "State of ART",
"maker": "Max Pryakhin",
"original_title": "State of ART",
"original_maker": "Max Pryakhin",
"preview": "https://static.art.art/previews/image.jpg"
}
}
]
}
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"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"7ea33ab4-91f7-41a3-93ac-c954bb70d973"
],
"description": "Идентификатор"
},
"priority": {
"type": "number",
"enum": [
0
],
"description": "Приоритет"
},
"artwork": {
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"update"
]
},
{
"type": "string",
"enum": [
"publish"
]
},
{
"type": "string",
"enum": [
"unpublish"
]
},
{
"type": "string",
"enum": [
"donate"
]
},
{
"type": "string",
"enum": [
"mint_nft"
]
},
{
"type": "string",
"enum": [
"renew"
]
},
{
"type": "string",
"enum": [
"transfer_to_client"
]
},
{
"type": "string",
"enum": [
"attach_domain"
]
},
{
"type": "string",
"enum": [
"enable_autorenew"
]
},
{
"type": "string",
"enum": [
"disable_autorenew"
]
}
],
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"1024688430153904"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"certificate_domain": {
"type": "string",
"enum": [
"1025106196959682.ip.art"
],
"description": "Домен сертификата"
},
"status": {
"type": "string",
"enum": [
"published"
],
"description": "Статус"
},
"nft": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"opensea",
"rarible"
],
"description": "Тип ссылки"
},
"link": {
"type": "string",
"enum": [
"https://opensea.io/assets/0xe86f180ef626e1ce4836718cfc090b03e870caca/1025980240980823"
],
"description": "Ссылка на NFT"
}
},
"required": [
"type",
"link"
],
"additionalProperties": false
},
"description": "Список ссылок на NFT сертификата"
},
"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",
"null"
],
"enum": [
"2019-07-25T13:18:46+0000",
null
],
"description": "Дата истечения сертификата (в формате ISO 8601)"
},
"expired": {
"type": [
"boolean",
"null"
],
"enum": [
false,
null
],
"description": "Просрочен ли домен"
},
"title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название"
},
"maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор"
},
"original_title": {
"type": "string",
"enum": [
"State of ART"
],
"description": "Название на языке оригинала"
},
"original_maker": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Автор на языке оригинала"
},
"preview": {
"type": "string",
"enum": [
"https://static.art.art/previews/image.jpg"
],
"description": "URL предпросмотра"
}
},
"required": [
"_acl",
"id",
"client",
"domain",
"certificate_domain",
"status",
"nft",
"created_at",
"updated_at",
"expired_at",
"expired",
"title",
"maker",
"original_title",
"original_maker"
],
"additionalProperties": false,
"description": "Арт-объект"
}
},
"required": [
"_acl",
"id",
"priority",
"artwork"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Отображение галереиGET/gallery{?limit,offset}
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"artwork": "1024688430153904",
"priority": 0
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"artwork": {
"type": "string",
"description": "Арт-объект"
},
"priority": {
"type": "number",
"description": "Приоритет"
}
},
"required": [
"artwork",
"priority"
]
}
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/gallery
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Body
{
"priority": 0
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"priority": {
"type": "number",
"description": "Приоритет"
}
},
"required": [
"priority"
]
}
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/gallery/{artworkGallery}
- artworkGallery
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257элемент галереи
Headers
Content-Type: application/json
Accept-Language: en
Authorization: Bearer JWT
Удаление элемента галереиDELETE/gallery/{artworkGallery}
- artworkGallery
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257элемент галереи
Файловое хранилище ¶
Файлы ¶
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"total": 123,
"items": [
{
"_acl": [
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"type": "uploads",
"created_at": "2019-07-25T13:18:46+0000",
"url": "https://static.art.art/uploads/image.jpg",
"name": "image.jpg",
"mime": "image/jpeg",
"size": 123
}
]
}
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": [
"delete"
]
},
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"type": {
"type": "string",
"enum": [
"uploads"
],
"description": "Тип"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/uploads/image.jpg"
],
"description": "URL файла"
},
"name": {
"type": "string",
"enum": [
"image.jpg"
],
"description": "Имя"
},
"mime": {
"type": "string",
"enum": [
"image/jpeg"
],
"description": "MIME-тип"
},
"size": {
"type": "number",
"enum": [
123
],
"description": "Размер (в байтах)"
}
},
"required": [
"_acl",
"id",
"client",
"type",
"created_at",
"url",
"name",
"mime",
"size"
],
"additionalProperties": false
},
"description": "Элементы текущей страницы"
}
},
"required": [
"total",
"items"
],
"additionalProperties": false
}
Просмотр файловGET/files{?client,type,url,limit,offset}
- client
string
(optional) Example: 59507894-1939-4b16-8a77-3e664c0eb257Клиент
- type
string
(optional) Example: uploadsТип
- url
string
(optional) Example: https://uploads.art.art/uploads/image.jpgURL
- limit
number
(optional) Example: 20Максимальное количество элементов в списке
- offset
number
(optional) Example: 0Отступ от начала списка
Headers
Accept-Language: en
Authorization: Bearer JWT
Headers
Content-Type: application/json
Body
{
"_acl": [
"delete"
],
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"client": "59507894-1939-4b16-8a77-3e664c0eb257",
"type": "uploads",
"created_at": "2019-07-25T13:18:46+0000",
"url": "https://static.art.art/uploads/image.jpg",
"name": "image.jpg",
"mime": "image/jpeg",
"size": 123
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"_acl": {
"type": "array",
"items": {
"type": "string",
"enum": [
"delete"
]
},
"description": "Права доступа"
},
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"client": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Клиент"
},
"type": {
"type": "string",
"enum": [
"uploads"
],
"description": "Тип"
},
"created_at": {
"type": "string",
"enum": [
"2019-07-25T13:18:46+0000"
],
"description": "Дата создания (в формате ISO 8601)"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/uploads/image.jpg"
],
"description": "URL файла"
},
"name": {
"type": "string",
"enum": [
"image.jpg"
],
"description": "Имя"
},
"mime": {
"type": "string",
"enum": [
"image/jpeg"
],
"description": "MIME-тип"
},
"size": {
"type": "number",
"enum": [
123
],
"description": "Размер (в байтах)"
}
},
"required": [
"_acl",
"id",
"client",
"type",
"created_at",
"url",
"name",
"mime",
"size"
],
"additionalProperties": false
}
Просмотр файлаGET/files/{file}
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Accept-Language: en
Authorization: Bearer JWT
Body
-----BOUNDARY
Content-Disposition: form-data; name="file"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"url": "https://static.art.art/images/image.jpg"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/images/image.jpg"
],
"description": "URL файла"
}
},
"required": [
"id",
"url"
],
"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/files/images
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Accept-Language: en
Authorization: Bearer JWT
Body
-----BOUNDARY
Content-Disposition: form-data; name="file"; filename="video.avi"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"url": "https://static.art.art/videos/video.avi"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/videos/video.avi"
],
"description": "URL файла"
}
},
"required": [
"id",
"url"
],
"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/files/videos
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARY
Accept-Language: en
Authorization: Bearer JWT
Body
-----BOUNDARY
Content-Disposition: form-data; name="file"; filename="file.pdf"
Content-Type: application/pdf
Content-Transfer-Encoding: base64
/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
-----BOUNDARY
Headers
Content-Type: application/json
Body
{
"id": "59507894-1939-4b16-8a77-3e664c0eb257",
"url": "https://static.art.art/static/file.pdf"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"59507894-1939-4b16-8a77-3e664c0eb257"
],
"description": "Идентификатор"
},
"url": {
"type": "string",
"enum": [
"https://static.art.art/static/file.pdf"
],
"description": "URL файла"
}
},
"required": [
"id",
"url"
],
"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/files/editorials
Headers
Accept-Language: en
Authorization: Bearer JWT
Удаление файлаDELETE/files/{file}
- file
string
(required) Example: 59507894-1939-4b16-8a77-3e664c0eb257Файл
Blockchain ¶
После вызова метода “регистрация домена” в ENS создается от 4 до 5 транзакций (в указанном порядке):
-
Регистрация домена (Занесение домена в реестр ENS с указанием адреса владельца - .ART)
-
Назначение адреса для домена - Регистрация пользовательского адреса Ethereum (если задан $.artwork.reference)
-
Регистрация Art Record
-
Регистрация Registrant
-
Назначение резолвера (Установка адреса резолвера .ART)
Возможны следующие статусы транзакции:
- processing - Транзакция выполняется
До определения конечного статуса считается, что транзакция находится на этапе выполнения.
- success - Транзакция успешно завершена
Транзакция считается успешно завершенной, если после ее регистрации обнаружено 6 и более подтвержденных блоков.
- fail - Транзакция отклонена, требуется повторная регистрация домена
Если отклоняется любая из транзакций, требуется повторное создание всех 4 или 5 транзакций.
Транзакции ¶
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"domain": "example.art",
"contact": {
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited"
},
"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": {
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
},
"contact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
}
},
"required": [
"name",
"organization"
],
"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": [
"domain",
"contact",
"artwork"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Пакетная регистрация домена с данными о артобъекте и контактахPOST/blockchain/transactions
Headers
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"id": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"status": "processing"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Идентификатор"
},
"status": {
"type": "string",
"enum": [
"processing"
],
"description": "Статус"
}
},
"required": [
"id"
],
"additionalProperties": false
}
Просмотр транзакцииGET/blockchain/transactions/{transaction}
- transaction
string
(required) Example: 0x9e200c2031b04e8a705c0d31325705bb2091b2a7Транзакция
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"domain": "example.art"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"domain": {
"type": "string",
"enum": [
"example.art"
],
"description": "Домен"
}
},
"required": [
"domain"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Регистрация доменаPOST/blockchain/domains
Возвращает список из 2-х транзакций:
-
регистрации домена в реестре ENS;
-
назначении резолвера для домена.
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Назначение резолвера для доменаPOST/blockchain/domains/{domain}/resolver
Возвращает список из 1 транзакции.
- domain
string
(required) Example: example.artДоменное имя (FQDN, U-labels)
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"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": {
"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
}
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Сохранение Art RecordsPOST/blockchain/domains/{domain}/artwork
Возвращает список из 1 транзакции.
- domain
string
(required) Example: example.artДоменное имя (FQDN, U-labels)
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"name": "Max Pryakhin",
"organization": "UK Creative Ideas Limited"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"Max Pryakhin"
],
"description": "Имя"
},
"organization": {
"type": "string",
"enum": [
"UK Creative Ideas Limited"
],
"description": "Организация"
}
},
"required": [
"name",
"organization"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Сохранение контактных данныхPOST/blockchain/domains/{domain}/contact
Возвращает список из 1 транзакции.
- domain
string
(required) Example: example.artДоменное имя (FQDN, U-labels)
Headers
Content-Type: application/json
Accept-Language: en
X-API-Key: api-key
Body
{
"address": "0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"address": {
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
],
"description": "Ethereum адрес"
}
},
"required": [
"address"
],
"additionalProperties": false
}
Headers
Content-Type: application/json
Body
{
"transactions": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7",
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"transactions": {
"type": "array",
"items": [
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
},
{
"type": "string",
"enum": [
"0x9e200c2031b04e8a705c0d31325705bb2091b2a7"
]
}
],
"description": "Транзакции"
}
},
"required": [
"transactions"
],
"additionalProperties": false
}
Назначение Ethereum-адреса домену в ENSPOST/blockchain/domains/{domain}/address
Возвращает список из 1 транзакции.
- domain
string
(required) Example: example.artДоменное имя (FQDN, U-labels)
Generated by aglio on 04 Jul 2023