Расшифровка параметров и статусов основных запросов

Для использования API необходимы специальные данные в частности партнерский код и секретный ключ (предоставляется нами), которые будут использоваться для формирования md5-хеш (захешированная строка из передаваемых параметров нужна для проверки целостности передаваемых данных и проверки на безопасность). Также нужно передавать краткие значения тарифов в запросе (предоставляются нами).

Получение данных для доступа на VPS-сервер после его аренды — api.govpsfx.com/server/server/get

параметры передаваемые в post запросе:

• Параметр rate — тариф. Возможные значения — для каждого партнера свои тарифы, например: singapore, france_classic, france_mini.
• Параметр term — срок аренды. Возможные значения — 1, 3, 6, 9, 12.
• Параметр partner_code — партнерский код. Возможные значения — 1880 (для каждого партнера уникальный предоставляется нами).
• Параметр client_id — ID клиента. Возможные значения — 16773 (уникальное числовое значение).
• Параметр hash — md5 хеш. Возможные значения — сформированный md5-хеш, описание по формированию md5-хеш читайте здесь.

Статусы ответов:

Код 200 — VPS-сервер предоставлен успешно. Пример ответа:

Json с данными VPS-сервера:

{
ip — 212.83.138.108
port — 8015
login — Admin
password – 4iJtCt7
created_at – 01.07.2020
end_at – 02.08.2020
rate – france_classic
client_id – 16773
server_id — 16773
}

• Код 202 — VPS-сервер подготавливается к выдаче, данные будут предоставлены, как только VPS будет создан. Чтобы получить данные для доступа на VPS-сервер после его аренды позже, партнер должен сделать на своей стороне обработчик для получения отложенных запросов. Более подробно читайте здесь. Ответ — order created,access to the server will be provided during the day.
• Код 400 — переданы некорректные параметры. Ответ — сообщение с описанием ошибки.
• Код 403 — передан неправильный md5-хеш, либо запрос не может быть выполнен. Ответ — сообщение с описанием ошибки.
• Код 500 — внутренняя ошибка сервера, нужно обратиться к техподдержке. Ответ — internal error.

После получения успешного ответа нужно сохранить полученные данные VPS-сервера в базе данных для дальнейшего использования, либо выдать клиенту статус операции об успешной выдаче VPS-сервера.

Продление сервера — api.govpsfx.com/server/prolongate

параметры передаваемые в post запросе:

• Параметр term — срок аренды. Возможные значения — 1, 3, 6, 9, 12.
• Параметр partner_code — партнерский код. Возможные значения — 1880 (для каждого партнера уникальный предоставляется нами).
• Параметр server_id — ID сервера. Возможные значения — 16773 (уникальное числовое значение).
• Параметр hash — md5-хеш. Возможные значения — сформированный md5-хеш, описание по формированию md5-хеш читайте здесь.

Статусы ответов:

— Код 200 — VPS-cервер продлен успешно. Пример ответа:

Json с датой окончания аренды VPS-сервера:

{
end_at – 02.08.2020
}

• Код 400 — переданы некорректные параметры. Ответ — сообщение с описанием ошибки.
• Код 403 — передан неправильный md5-хеш, либо запрос не может быть выполнен. Ответ — сообщение с описанием ошибки.
• Код 500 — внутренняя ошибка сервера, нужно обратиться к техподдержке. Ответ — internal error.

После получения успешного ответа, нужно обновить данные VPS-сервера, конкретно — дату окончания сервера. Либо, если произошла ошибка, выдать клиенту сообщение об ошибке.

Отзыв сервера — api.govpsfx.com/server/revoke

параметры передаваемые в post запросе:

• Параметр server_id — ID сервера. Возможные значения — 16773 (для каждого VPS уникальный предоставляется нами).
• Параметр partner_code — партнерский код. Возможные значения — 1880 (для каждого партнера уникальный предоставляется нами).
• Параметр hash — md5-хеш. Возможные значения — сформированный md5-хеш, описание по формированию md5-хеш читайте здесь.

Статусы ответов:

• Код 200 — заявка на отзыв создана успешно. Ответ — 1.
• Код 400 — переданы некорректные параметры. Ответ — сообщение с описанием ошибки.
• Код 403 — передан неправильный md5-хеш, либо запрос не может быть выполнен. Ответ — сообщение с описанием ошибки.
• Код 500 — внутренняя ошибка сервера, нужно обратиться к техподдержке. Ответ — internal error.

После получения успешного ответа, нужно удалить VPS-сервер в базе данных, если произошла ошибка, выдать клиенту сообщение об ошибке.