Общая информация
API позволяет пользователю автоматизировать большинство действий, которые могут быть выполнены в панели клиента Artnet.
Соединение с API осуществляется путем подключения к серверу artnet.pl через протокол
HTTPS. Каждая команда имеет свой собственный URL-адрес, который должен вызываться в запросе типа
POST с параметрами команды, заданными как переменные POST. Запрос, отправленный в API, должен выглядеть так, как будто он был отправлен из HTML-формы. Ответ сервера всегда - это объект
JSON.
Подключение
Адрес для подклюения с API:
https://panel.artnet.pl/api/NAME/COMMANDS
Строка
/NAME/COMMANDS соответствует имени команды, которое вызывается, как указано в разделе «Команды API» этой документации.
Авторизация
Данные авторизации отправляются в каждом запросе в виде параметров
id
(идентификационный номер клиента) и
api_key
(ключ авторизации API). ID клиента (
id
) - это такой же номер, что и при входе в панель клиента. Ключ API (
api_key ) можно найти в панели клиента - выберите «Данные клиента» в меню, а затем в разделе «Инструменты» выберите ссылку «Управление доступом к API». Если доступ к API не включен, то нужно его включить - это приведет к созданию нового ключа API.
Пример запроса
Образец запроса вместе с заголовками для получения подробной информации об услуге с помощью команды
/services/details имеет следующий вид:
POST
/panel/api/services/details HTTP/1.1 Host: artnet.pl Cache-Control:
no-cache Content-Type: application/x-www-form-urlencoded
api_key=XXXXXXXXXXXXXXX&id=19052&service_id=12345
Ответ сервера
Ответ сервера всегда является объектом JSON. Каждый ответ включает поле
success
(
boolean), значение которого указывает, была ли команда успешной. Если выполнение команды не удалось, поле
success
примет значение
false, а также будет возвращен объект
error
, содержащий информацию об ошибке. Если команда выполнена успешно, ответ может содержать только
success
, а также может содержать другое поле, как описано в разделе «Команды API».
Примерные ответы
Пример ответа об ошибке:
{ "success": false,
"error": { "code": "unknown-command", "description": { "pl":
"Nieznane polecenie", "en": "Unknown command" } } }
Пример правильного ответа (команда:
/services/details):
{ "service": { "id":
12345, "type": "dedicated", "name": "HP DL120 G7 123.123.123.123",
"custom_description": null, "expiration_time": 1481213614,
"payment_details": { "price": 527, "price_brutto": 648.21,
"currency": "EUR", "payment_period": "1" }, "parent_service_id": 0,
"ip": "123.123.123.123" }, "success": true }
Виды услуг
- dedicated - выделенный сервер
- colocation - колокейшн
- vps - сервер VPS
- domain - дамены
- additional-ip - дополнительные адреса IP
- avx - виртуальный хостинг AVX.pl
- easyisp - виртуальный хостинг EasyISP.pl
- hosting-artnet - виртуальный хостинг Artnet.pl
- foip - Fail-over IP
- link - интернет подключение
- software - лицензия на ПО
- ssl - сертификат SSL
- other - другая услуга
Команды API
Блок: customer
Управление данными клиента.
/customer/regenerate-api-key - генерация нового ключа API
Создание нового ключа API. Новый ключ возвращается в ответ. Генерация ключа автоматически аннулирует существующий ключ - все будущие запросы должны быть авторизованы с помощью нового ключа.
Ответ:
- api_key (string) - новый сгенерированный ключ API
Коды ошибок:
/customer/emails-list - список отправленных сообщений email
Список недавно отправленных сообщений электронной почты. Заголовки сортируются по убыванию по дате отправки.
Парамерты:
- limit
(number) -
максимальное количество загружаемых заголовков
- offset
(number) -
номер записи, с которого должны сортироваться заголовки
Ответ:
-
emails_list (objects-list) - список заголовков сообщений
- id (number) - уникальный ID сообщения
- time (timestamp) - время отправления сообщения
- subject (string) - тема сообщения
Коды ошибок:
/customer/email-details - детали высланного письма email
Получение информации о сообщении email.
Парамерты:
- email_id
(number) -
ID сообщения email
Ответ:
-
email (object) - детали сообщения email
- id (number) - уникальный ID сообщения
- time (timestamp) - время отправки сообщения
- address (string) - адрес, на который выслан email
- subject (string) - тема сообщения
- body (string) - содержание сообщения
Коды ошибок:
/customer/change-language - смена языка
Изменение языка по умолчанию. Используется для языка, используемого в переписке, и в панели клиентов.
Парамерты:
- language
(string) -
название языка
Коды ошибок:
/customer/get-language - проверка языка
Возвращает актуальный установленный язык (для сообщений email и
панели клиента).
Ответ:
- language (string) - название языка
/customer/details - детали клиента
Загрузка подробных данных о клиенте.
Ответ:
-
customer (object) - детали клиента
- id (number) - уникальный ID
- name (string) - имя клиента
- nip (string) - NIP номер (VAT identification number)
- regon (string) - номер REGON или PESEL
- street (string) - адрес клиента - улица
- postcode (string) - адрес клиента - почтовый код
- city (string) - адрес клиента - город
- country_code (string) - адрес клиента - код страны
- country_label (string) - адрес клиента - название страны
- tel (string) - номер телефона
- fax (string) - номер факса
- email (string) - адрес email
- email_tech (string) - технический адрес email
- email_invoice (string) - адрес email бухгалтера (для отправки электронных счетов)
- correspondence_name (string) - адрес для корреспонденции - имя получателя
- correspondence_street (string) - адрес для корреспонденции - улица
- correspondence_postcode (string) - адрес для корреспонденции - почтовый код
- correspondence_city (string) - адрес для корреспонденции - город
- business (boolean) - юридическая форма (true - организация, false - физическое лицо)
- language (string) - используемяй язык
- currency (string) - код валюты по-умолчанию
Коды ошибок:
/customer/edit - редактирование данных клиента
Редактирование данных клиента. Позволяет изменять данные клиента, включая контактные данные. Все команды являются необязательными, изменения выполняются только для заданных параметров.
Парамерты:
- customer[name]
(string) -
Название клиента
- customer[nip]
(string) -
NIP номер (VAT identification number)
- customer[regon]
(string) -
номер REGON или PESEL
- customer[street]
(string) -
адрес клиента - улица
- customer[postcode]
(string) -
адрес клиента - почтовый код
- customer[city]
(string) -
адрес клиента - город
- customer[country_code]
(string) -
адрес клиента - код страны
- customer[tel]
(string) -
номер телефона
- customer[fax]
(string) -
номер факса
- customer[email]
(string) -
адрес email
- customer[email_tech]
(string) -
адрес email технического контакта
- customer[email_invoice]
(string) -
адрес email бухгалтера(для электронных счетов)
- customer[correspondence_name]
(string) -
адрес для корреспонденции - название получателя
- customer[correspondence_street]
(string) -
адрес для корреспонденции - улица
- customer[correspondence_postcode]
(string) -
адрес для корреспонденции - почтовый код
- customer[correspondence_city]
(string) -
адрес для корреспонденции - город
- customer[business]
(string) -
Юридическая форма (true - компания, false - филическое лицо)
Коды ошибок:
Блок: Услуги
Список услуг и основные операции по обслуживанию клиентов.
/services/list - список услуг
Список услуг клиента. Может быть отфильтрована по типу услуги.
Парамерты:
- limit
(number) -
максимальное количество загружаемых записей
- offset
(number) -
смещение первой загружаемой записи
- service_type
(string) -
тип услуги (если задано значение, будут возвращены только услуги определенного типа)
- parent_service_id
(number) -
ID родительской услуги (если он задан и не равен нулю, только вспомогательные службы будут возвращены службе с данным идентификатором)
Ответ:
-
services_list (objects-list) - Список услуг
- id (number) - уникальный ID услуги
- type (string) - тип услуги
- name (string) - имя идентификатора службы (название домена, логин хостингового аккаунта и др) или название услуги.
- custom_description (string) - собственное (клиента) описание услуги
- expiration_time (timestamp) - срок действия услуги
-
payment_details (object) - детали касающиеся цены услуги и оплаты
- price (number) - цена netto за расчетный период
- price_brutto (number) - цена brutto за расчетный период
- currency (string) - код валюты
- payment_period (number) - расчетный период (количество месяцев)
- parent_service_id (number) - ID родительской службы (если служба связана с родительской службой) или 0
- ip (string) - адрес IP, если есть
Коды ошибок:
/services/details - детали услуги
Возвращает детальную информацию, касающуюся выбранной услуги.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service (object) - детали услуги
- id (number) - уникальный ID услуги
- type (string) - тип услуги
- name (string) - название идентификатора услуги (имя домена, логин учетной записи хостинга и т. д.) или название службы
- custom_description (string) - собственное (клиента) описание услуги
- expiration_time (timestamp) - срок действия услуги
-
payment_details (object) - детали касающиеся цены услуги и оплаты
- price (number) - цена netto за расчетный период
- price_brutto (number) - цена brutto за расчетный период
- currency (string) - код валюты
- payment_period (number) - расчетный период (количество месяцев)
- parent_service_id (number) - ID родительской службы (если служба связана с родительской услугой) или 0
- ip (string) - адрес IP, если есть
Коды ошибок:
Блок: домен
Список услуг и основные операции по услугам клиента.
/domain/list - список доменов
Возвращает список свех доменов. Команда работает так же как /services/list с параметром service_type=domain.
/domain/details - детали домена
Возвращает детальную информацию касающуюся домена.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали домена
- id (number) - уникальный ID услуги
- domain_name (string) - название домена
- manageable (boolean) - определяет, можно ли автоматически изменять DNS-серверы (если это поле принимает значение false, это означает, что изменение DNS-серверов для этого домена требует обращения в отдел обслуживания клиентов)
- dns_servers (ordered-list) - список серверов DNS домена (очередность важна); если в системе Artnet нету информации о заполненных серверах DNS это поле будет отсутствовать
Коды ошибок:
/domain/edit-dns-servers - редактирование делегирования DNS домена
Изменяет делегированные LYC домена.
Парамерты:
- service_id
(number) -
номер ID услуги
- dns_servers
(list) -
последующие адреса DNS-серверов в качестве элементов списка (порядок важен)
Коды ошибок:
- invalid-service-type
- incorrect-param-value
- dns-servers-insufficient
- edit-dns-error
Блок: easyisp
Список услуг хостинга под маркой EasyISP.
/easyisp/list - список услуг
Возвращает список всех хостинговых услуг EasyISP. Команда работает так же как /services/list с параметром
service_type=easyisp.
/easyisp/details - сведения об услуге хостинга EasyISP
Возвращает детальную информацию косающуюся услуг хостинга EasyISP.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
- login (string) - логин
- package (string) - название пакета
Коды ошибок:
Блок: avx
Список услуг хостинга под маркой AVX.
/avx/list - список услуг
Возвращает список всех хостинговых услуг. Команда работает так же как /services/list с параметром service_type=avx.
/avx/details - сведения об услуге хостинга AVX
Возвращает детальную информацию косающуюся услуг хостинга AVX.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
- login (string) - логин
- package (string) - название пакета
Коды ошибок:
Блок: хостинг-artnet
Список услуг хостинга под маркой Artnet.
/hosting-artnet/list - список услуг
Возвращает список всех хостинговых услуг. Команда работает так же как /services/list с параметром service_type=hosting-artnet.
/hosting-artnet/details - сведения об услуге хостинга
Возвращает детальную информацию косающуюся услуг хостинга.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
- login (string) - логин
- package (string) - название пакета
Коды ошибок:
Блок: ssl
Список сертификатов SSL.
/ssl/list - список услуг
Возвращает список всех хостинговых услуг. Команда работает так же как /services/list с параметром service_type=ssl.
/ssl/details - детали сертификата SS
Возвращает детальную информацию косающуюся услуги.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
- domain (string) - название домена связанного с сертификатом SSL
-
certificate (object) - объект, описывающий имя сертификата
- pl (string) - название сертификата на польском языке
- en (string) - название сертификата на английском языке
Коды ошибок:
Блок: программное обеспечение
Список лицензий на ПО.
/software/list - список услуг
Возвращает список всех лицензий ПО. Команда работает так же как /services/list с параметром service_type=software.
/software/details - детали лицензий
Возвращает детальную информацию касающуюся лицензий на ПО.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
-
licence (object) - детали лицензии
- name (string) - название ПО и лицензии
- licences_number (number) - количество лицензий в рамках этой услуги
Коды ошибок:
Блок: link-service
список услуг подключения к интернету.
/link-service/list - список услуг
Возвращает список всех услуг подключения к интернету. Команда работает так же как /services/list с параметром
service_type=link.
/link-service/details - детали подключения к интернету
Возвращает детальную информацию касающуюся услуг подключения к интернету.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
-
bandwidth (object) - Пропусная способность.
- up (number) - Исходящая скорость [Mbps].
- down (number) - Входящая скорость [Mbps].
-
network_configuration (object) - Конфигурация сети.
- ip (string) - адрес IP подключения
- mask (string) - маска подсети
- mask_short (string) - ярлык маски адреса подсети (в форме, например, "/32")
Коды ошибок:
Блок: fail-over-ip
Управление услугами fail-over IP.
/fail-over-ip/list - список услуг
Возвращает список всех услуг fail-over IP. Команда работает так же как /services/list с параметром
service_type=foip.
/fail-over-ip/details - детали услуги
Возвращает детальную информацию касающуюся услуги fail-over IP.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
- virtual_ip (string) - Виртуальный, постоянный IP-адрес, видимый снаружи.
- real_ip (string) - Фактический IP-адрес, по которому трафик в настоящее время пересылается, или false, если услуга не активна.
- real_ips_allowed_list (strings-list) - Список IP-адресов, на которые можно перенаправить трафик.
Коды ошибок:
/fail-over-ip/switch - переключает фактический адрес IP
Переключает целевой (реальный) адрес, по которому входящий трафик перенаправляется на внешний (виртуальный) IP-адрес.
Парамерты:
- service_id
(number) -
номер ID услуги
- real_ip
(string) -
новый адрес назначения (должен быть в списке разрешенных адресов)
Коды ошибок:
- authorization-failed
- invalid-service-type
- incorrect-param-value
- ip-not-allowed
- internal-fail-over-ip-error
Блок: дополнительный ip
Управление услугами дополнительных адресов IP. Этот тип сервиса позволяет вам перечислять и заказывать новые дополнительные IP-адреса для услуг центра обработки данных (выделенные серверы, collocations, VPS-серверы)
/additional-ip/list - список услуг
Возвращает список всех услуг dodatkowych adresów IP. Команда работает так же как /services/list с параметром
service_type=additional-ip.
/additional-ip/details - детали услуги
Возвращает детальную информацию касающуюся услуги дополнительных адресов IP.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
-
subnetworks (objects-list) - список подсетей
- id (number) - уникальный номер ID подсети
- ip (string) - адрес сети
- mask (string) - маска подсети
- mask_short (string) - подсеть (в записе вида '/29')
- type (string) - тип подсети (IPv4 / IPv6)
Коды ошибок:
/additional-ip/order-info - информация / цены на дополнительные IP
Возвращает информацию о заказе дополнительных IP-адресов. Заказанные адреса должны всегда ассоциироваться с определенным сервером (выделенный сервер, колокейшн, VPS) и расчетный период для платежей, а валюта определяется деталями платежа сервера. Команда позволяет узнать цену, рассчитанную для одного IP-адреса, связанного с конкретной услугой. При заказе большего количества IP-адресов конечная цена будет рассчитываться как цена за один IP-адрес на количество заказнных адресов. После завершения заказа цена дополнительных адресов будет добавлена к цене сервера. Помимо данных о ценах, команда также возвращает информацию о максимальном количестве доступных IP-адресов, которые можно заказать в данный момент.
Парамерты:
- parent_service_id
(number) -
номер ID сервера, для которого нужно расчитать цену дополнительного адреса IP
Ответ:
-
order_info (object) -
- maximum_ips_number (number) - максимальное чиско адресов IP, которые можно получить в момет заказа
-
one_ip_payment_details (object) - объект, описывающий детали платежи для ОДНОГО дополнительного IP-адреса
- price (number) - цена за один адрес IP (netto)
- price_brutto (number) - цена за один адрес IP (brutto)
- currency (string) - код валюты (доступны PLN, EUR, USD)
- payment_period (number) - период расчетов (количество месяцев)
Коды ошибок:
- invalid-parent-service-type
/additional-ip/order - заказ дополнительных адресов IP
Реализует заказ дополнительных IP-адресов для выбранной услуги (выделенный сервер, коллокация, VPS). Размещение заказа автоматически назначает IP-адреса выбранной услуге - назначенные адреса возвращаются в соответствующем заказе и сразу готовы к настройке (каждый адрес с маской 255.255.255.255). Размещение заказа приводит к автоматическому повышению цены услуги на цену IP-адресов (это цена за один IP-адрес для выбранного сервиса, умноженная на количество выбранных адресов) - адреса всегда заказываются за тот же период оплаты, что и оплата за родительскую услугу. Цена одного IP-адреса для данной услуги может быть проверена с помощью команды /additional-ip/order-info
Парамерты:
- parent_service_id
(number) -
номер ID услуги сервера, к которому должна быть назначена
addresy
- ips_number
(number) -
количество новых адресов для назначения
Ответ:
-
order_details (object) - детали заказа
- service_id (number) - уникальный ID новой услуги дополнительных адресов IP
- ips_number (number) - количество добавленных адресов IP
-
ips_configuration (objects-list) - список объектов, описывающих конфигурацию заказанных адресов
- ip (string) - адрес IP
- mask (string) - маска с которой должен быть сконфигурирован адрес на сервере
Коды ошибок:
- invalid-parent-service-type
- invalid-ips-number
- internal-service-create-error
- internal-service-update-error
- internal-additional-ip-error
Блок: vps
Список серверов VPS.
/vps/list - список услуг
Возвращает список всех услуг серверов VPS. Команда работает так же как /services/list с параметром
service_type=vps.
/vps/details - детали serwera VPS
Возвращает детальную информацию касающуюся сервера VPS.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали
- id (number) - уникальный ID услуги
-
newtwork_configuration (object) - сетевая конфигурация сервера
- ip (string) - главный IP адрес сервера VPS
- additional_ips_list (strings-list) - список дополнительных IP адресов
-
features (object) - доступные функции для этого сервера
- power_management (boolean) - если true, то можно управлять питанием этого VPS
- power_state (string) - описывает состояние питания VPS (может принимать значения:
"unknown", "on", "off")
- active (boolean) - описывает активен ли этот сервер (true) или заблокирован (false)
Коды ошибок:
/vps/power-on - смена состояния VPS на ВКЛЮЧЕН
Смена состояния питания VPS на: ВКЛЮЧЕН.
Парамерты:
- service_id
(number) -
номер ID услуги
- confirm
(string) -
значение этого поля долно быть установлено на "confirm"
Коды ошибок:
- invalid-service-type
- service-suspended
- unsupported-feature
- unconfirmed
- internal-operation-error
/vps/power-off - смена состояния VPS на ВЫКЛЮЧЕН
Смена состояния питания VPS на: ВЫКЛЮЧЕН.
Парамерты:
- service_id
(number) -
номер ID услуги
- confirm
(string) -
значение этого поля долно быть установлено на "confirm"
Коды ошибок:
- invalid-service-type
- service-suspended
- unsupported-feature
- unconfirmed
- internal-operation-error
/vps/power-restart - перезапуск VPS
Перезагрузка сервера VPS. Выполняется через ВЫКЛЮЧЕНИЕ и затем ВКЛЮЧЕНИЕ питания сервера.
Парамерты:
- service_id
(number) -
номер ID услуги
- confirm
(string) -
значение этого поля долно быть установлено на "confirm"
Коды ошибок:
- invalid-service-type
- unsupported-feature
- service-suspended
- unconfirmed
- internal-operation-error
Блок: Выделенные серверы
Управление услугами выделенных серверов.
/dedicated/list - список выделенных серверов
Возвращает список выделенных серверов. Команда работает так же как /services/list с параметром service_type=dedicated.
/dedicated/details - детали serwera dedykowanego
Возвращает детальную информацию касающуюся выделенного сервера.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
service_details (object) - детали сервера
- id (number) - уникальный ID услуги
-
hardware_configuration (object) - детали конфигурации
-
server (object) - детали сервера
- vendor (string) - Вендор
- model (string) - название модели
-
cpu (objects-list) - список процессоров
- vendor (string) - Изготовитель
- model (string) - название модели
- clock (number) - частота процессора [GHz]
- cores (number) - количество ядер
- ht (boolean) - поддердка hyper-threading
-
ram (objects-list) - список модулей RAM
- capacity (number) - объем [GB]
- type (string) - модель
- speed (number) - скорость [MHz]
-
hdd (objects-list) - список HDD
- capacity (number) - объем [GB]
- type (string) - тип диска
- speed (string) - скорость
-
hdd_controller (objects-list) - список контроллеров HDD
- model (string) - название модели
- builtin (boolean) - информация о том, встроен ли контроллер
-
network_configuration (object) - детали конфигурации сети
- ip (string) - адрес IP
- additional_ips (strings-list) - список дополнительных адресов IP
-
subnetworks (objects-list) - список подсетей
- id (number) - уникальный номер ID подсети
- ip (string) - адрес сети
- mask (string) - маска подсети
- mask_short (string) - сокращение подсети (в записе '/29')
- type (string) - тип подсети (IPv4 / IPv6)
- firewall_ruleset_id (string) - идентификатор набора правил брандмауэра для этого сервера; в зависимости от сетевой конфигурации ваших серверов, один набор правил может применяться к одному (обычно) или нескольким вашим серверам; если конфигурация брандмауэра для этого сервера недоступна, это поле не будет заполнено
-
features (object) - доступные функции для этого сервера
- ilo_access_management (boolean) - если true можно включить доступ к ILO / IPMI для этого сервера
- power_management (boolean) - если true можно управлять питанием этого сервера
- firewall_management (boolean) - если true вы можете управлять внешними правилами брандмауэра для этого сервера
- active (boolean) - описывает активен ли сервера (true) или заблокирован (false)
Коды ошибок:
/dedicated/transfer-usage-details - информация о потреблении трафика
Возвращает подробную информацию об использовании трафика сервером в последние 3 и текущий расчетный период.
Парамерты:
- service_id
(number) -
номер ID услуги
Ответ:
-
transfer_usage_details (object) - детали использования трафика
-
periods_list (objects-list) - информация о использовании трафика в детальных расчетных периодах
-
time_range (object) - объект, определяющий период
- from (number) - отметка времени (UNIX) с указанием начала периода
- from (number) - отметка времени (UNIX) с указанием начала периода
-
transfer_usage (object) - объект, определяющий потребление трафика за период
- up (number) - количество входящих данных [байты]
Коды ошибок:
- invalid-service-type
- unsupported-feature