SSL (certificate/sslkey)

SSL-сертификаты

Функция: certificate

Результат: список элементов

SSL cертификаты

Уровень доступа: admin user

Параметр	Значение
id	Id
CN	Домен
account	Клиент
pricelist	Тариф
project	Провайдер
processingmodule	Модуль обработки
createdate	Дата создания
expiredate	Действует до
status_msg
item_status	статус услуги. Может принимать значения: 1 — заказана; 2 — активна; 3 — остановлена; 4 — удалена; 5 — обрабатывается;
cost	Стоимость

Перезапуск обработки сертификата

Функция: certificate.retry

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Перевыпуск сертификата

Функция: certificate.reissue

Уровень доступа: admin user

Включить

Функция: certificate.resume

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Установить фильтр по клиенту

Функция: certificate.setfilter

Уровень доступа: admin

Заказать сертификат

Функция: certificate.order

Уровень доступа: user

Открытие услуги

Функция: certificate.open

Уровень доступа: admin

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции certificate)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции certificate)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см.выше):

crt — Сертификат. DER представление сертификата

processingmodule — Модуль обработки. Модуль обработки, назначенный услуге

Войти в панель с правами пользователя

Функция: certificate.su

Уровень доступа: admin

Получение статуса сертификата

Функция: certificate.sync

Уровень доступа: admin

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Установка фильтра.

certificate.filter

Удалить выделенные записи

Функция: certificate.delete

Уровень доступа: admin user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции certificate.

Результат: успешное выполнение операции или сообщение об ошибке

Сертификат

Функция: certificate.edit

Уровень доступа: admin user

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент id из функции certificate)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции certificate)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
autoprolong	Автоматическое продление. Выберите период, на который услуга будет продляться автоматически при окончании срока действия
createdate	Дата заказа услуги
opendate	Дата создания. Дата фактического начала действия услуги
expiredate	Действует до. Срок действия услуги
service_status
custom_order_id	Идентификатор сертификата в центре выдачи
noexpense	Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Поставьте флаг, если не нужно списывать/возвращать деньги за текущую операцию изменения ресурсов
CN	Домен. Если сертификат защищает 1 домен, введите www.example.com. Если он защищает поддомены, укажите как *.example.com Если вы покупаете мультидоменный сертификат, введите 1 домен вида www.example.com. Дополнительные домены вы введете на следующем шаге.
field_country	Страна. Выберите страну из списка
ST	Регион. Укажите регион — область, край, республика, город федерального значения и т.д. Допускается использование только символов латиницы
L	Город или местность. Укажите город или местность, которая будет отображена в сертификате. Допускается использование только символов латиницы
O	Организация. Укажите полное название организации так, как оно указано в Свидетельстве о регистрации юридического лица либо ФИО, если сертификат будет выписан на физическое лицо. Для сертификатов с расширенной проверкой (EV) также необходимо указать юридическую форму. Допускается использование только символов латиницы
OU	Подразделение. Укажите подразделение организации, если необходимо. Допускается использование только символов латиницы
emailAddress	Email. Укажите контактный Email, если вы хотите что бы он отображался в свойствах сертификата

Скачивание сертификата

Функция: certificate.file

Уровень доступа: admin.

Функция для скачивания файлов сертификата.

Параметры:

elid — уникальный идентификатор (элемент id из функции certificate)
Type — тип файла, может принимать значения: csr, key.

Редактирование сертификата/запроса на сертификат

Функция: certificate.file.edit

Уровень доступа: admin.

Параметры:

elid — уникальный идентификатор (элемент id из функции certificate)
type — тип файла, может принимать значения: csr, crt.
data — новые данные сертификата, если type = crt или новые данные запроса, если type=csr.

SSL ключи

Функция: sslkey

Результат: список элементов

SSL ключи

Уровень доступа: user

Параметр	Значение
server	Адрес панели
user	Пользователь
cert	Сертификат
start	Дата создания
expire	Дата окончания
props	Свойства

Скачать ключ

Функция: sslkey.download

Вы можете скачать ключ. Данная операция может быть выполнена только один раз. После скачивания, файл ключа будет удален

Уровень доступа: user

Новый SSL ключ

Функция: sslkey.edit

Уровень доступа: user

Просмотр параметров объекта:

Параметры:
- elid — уникальный идентификатор (элемент key из функции sslkey)
Результат: список параметров объекта

Создание объекта:

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент key из функции sslkey)
- дополнительные параметры запроса ...
Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

Параметр	Значение
server	Адрес панели. Различные адреса панели могут использовать различные SSL сертификаты для авторизации. Новый ключ будет действителен только для сертификата, используемого на данном адресе
self	Необязательный параметр. Чтобы включить данную опцию используйте значение "on". Вы можете создать ключ для текущего пользователя или для любого другого пользователя, владельцем которого является текущий
username	Имя пользователя. Введите имя пользователя, для которого вы намереваетесь создать ключ. Вы должны быть владельцем этого пользователя
type	Действие. Вы можете создать новый ключ, использовать уже существующий, использовать текущий ключ (в случае, если для текущего подключения вы использовали ключ, не зарегистрированный в панели) или получить подписанный сертификат, чтобы сформировать ключ вручную
name	Имя ключа. Произвольное имя, которое будет отображаться при выборе сертификата
period	Срок действия (дней). Новый ключ будет действителен в течении указанного количества дней начиная с текущего дня
passwd	Пароль, которым будет закрыт созданный SSL ключ
confirm	Подтверждение
subject	Имя ключа. Укажите имя имеющегося у вас ключа. Внимание, ваш ключ должен быть подписан сертификатом, указанным в настройках HTTP сервера
request	Запрос SSL сертификата. В этом случае вы получите подписанный сертификат, для того, чтобы сформировать ключ, вам необходимо запаковать его в формате PKCS#12. Например, это может быть сделано следующей командой: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:ваш пароль

Удалить

Функция: sslkey.delete

Уровень доступа: user

Параметры:

elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции sslkey.

Результат: успешное выполнение операции или сообщение об ошибке