migrate.php¶
В этой статье
- Методы API
- migrate/accept_migration_invapi
- migrate/cancel_migration
- migrate/check_hosting_to_move
- migrate/check_part_of_list
- migrate/contacts
- migrate/convert_price
- migrate/customer
- migrate/customer_suggest_list
- migrate/get_csv
- migrate/get_customers
- migrate/get_customers_by_email_list
- migrate/get_hosting_to_move
- migrate/get_hostings_list
- migrate/get_inactive_customers
- migrate/get_migrated_customers
- migrate/get_order_to_move
- migrate/get_part_of_list
- migrate/hosting
- migrate/migrate_inactive_list
- migrate/number_customer_lists
- migrate/put_hosting_to_move
- migrate/rollback_inactive_list
Модуль управления миграцией данных: управление клиентами, хостингом, конвертация цен и работа с очередями миграции
Методы API¶
| Метод | Действие | Описание |
|---|---|---|
accept_migration_invapi | принятие инвайта API | Принимает приглашение на миграцию через API. |
cancel_migration | отмена миграции | Отменяет текущую процесс миграции. |
check_hosting_to_move | проверка хостинга к переносу | Проверяет возможность переноса хостинга и рассчитывает конвертацию валют. |
check_part_of_list | проверка части списка | Проверяет наличие элементов в списке миграции. |
contacts | контакты | Получение данных контактов. |
convert_price | конвертация цены | Конвертирует сумму из одной валюты в другую. |
customer | клиент | Получение информации о клиенте. |
customer_suggest_list | получение предложений по клиентам | Возвращает список подсказок (предложений) клиентов на основе поискового запроса. |
get_csv | получение CSV данных | Возвращает данные в формате CSV для скачивания. |
get_customers | получение списка клиентов | Возвращает список клиентов с поддержкой пагинации и фильтрации по локации. |
get_customers_by_email_list | получение клиентов по списку email | Возвращает список клиентов на основе предоставленного списка Email-адресов. |
get_hosting_to_move | получение хостингов для переноса | Возвращает данные о доступных хостингах (серверах) для миграции в указанной локации. |
get_hostings_list | получение списка хостингов | Возвращает список хостингов, доступных для миграции в рамках указанной локации. |
get_inactive_customers | получение неактивных клиентов | Возвращает список неактивных клиентов с фильтрацией по датам, типам и статусам сервисов. |
get_migrated_customers | получение мигрировавших клиентов | Возвращает список клиентов, прошедших процедуру миграции за указанный период. |
get_order_to_move | получение заказа для переноса | Возвращает детальную информацию о заказе, доступном для миграции. |
get_part_of_list | получение части списка | Возвращает фрагмент (страницу) списка клиентов с учетом пагинации. |
hosting | миграция хостинга | Выполняет миграцию параметров хостинга. |
migrate_inactive_list | миграция неактивного списка | Запускает процесс миграции неактивных клиентов. |
number_customer_lists | подсчет списков клиентов | Сравнивает количество записей в двух биллинговых локациях. |
put_hosting_to_move | сохранение переноса хостинга | Завершает процесс миграции хостинга, обновляет данные в биллинге и логирует изменения. |
rollback_inactive_list | откат списка неактивных записей | Выполняет откат изменений для списка неактивных клиентов. Поддерживает режим пробного запуска (dry run). |
migrate/accept_migration_invapi¶
Принимает приглашение на миграцию через API.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: accept_migration_invapi |
| token | ✅ | string | Токен авторизации |
| data | ❌ | array<string> | Дополнительные данные для обработки |
Пример запроса
migrate/cancel_migration¶
Отменяет текущий процесс миграции.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: cancel_migration |
| token | ✅ | string | Токен авторизации |
| data | ❌ | array<string> | Параметры отмены (может быть JSON-строкой) |
Пример запроса
Пример успешного ответа
migrate/check_hosting_to_move¶
Проверяет возможность переноса хостинга и рассчитывает конвертацию валют.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: check_hosting_to_move |
| token | ✅ | string | Токен авторизации |
| ❌ | string | Email клиента | |
| hosting | ❌ | array<string> | Данные хостинга (может быть JSON-строкой) |
| location | ❌ | string | Идентификатор или название локации для проверки возможности переноса хостинга. |
Пример запроса
migrate/check_part_of_list¶
Проверяет наличие элементов в списке миграции.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: check_part_of_list |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| list | ❌ | array<string> | Список элементов для проверки |
| location | ❌ | string | Местоположение или адрес объекта для проверки части списка. |
Пример запроса
migrate/contacts¶
Получение данных контактов.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: contacts |
| token | ✅ | string | Токен авторизации |
| data | ❌ | array<string> | Данные для поиска контактов |
Пример запроса
Пример успешного ответа
migrate/convert_price¶
Конвертирует сумму из одной валюты в другую.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: convert_price |
| token | ✅ | string | Токен авторизации |
| amount | ❌ | number | Сумма для конвертации |
| from_currency | ❌ | string | Исходная валюта. По умолчанию EUR. |
| to_currency | ❌ | string | Целевая валюта. По умолчанию EUR. |
Пример запроса
migrate/customer¶
Получение информации о клиенте.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: customer |
| token | ✅ | string | Токен авторизации |
| ❌ | string | Email клиента | |
| from | ❌ | string | Дата начала (от) |
| to | ❌ | string | Дата окончания (до) |
Пример запроса
Пример успешного ответа
migrate/customer_suggest_list¶
Возвращает список подсказок (предложений) клиентов на основе поискового запроса.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: customer_suggest_list |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| search | ❌ | string | Поисковый запрос для подбора клиентов. |
| location | ❌ | string | Местоположение или локация для получения списка предложений. |
Пример запроса
Пример успешного ответа
migrate/get_csv¶
Возвращает данные в формате CSV для скачивания.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_csv |
| token | ✅ | string | Токен авторизации |
| csvrow[] | ❌ | array<string> | Массив строк для формирования CSV файла. Принимает несколько значений: csvrow[]=line1&csvrow[]=line2 |
| csvrow | ✅ | string | Параметр csvrow |
Пример запроса
migrate/get_customers¶
Возвращает список клиентов с поддержкой пагинации и фильтрации по локации.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: get_customers |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| limit | ❌ | integer | Количество записей на страницу. По умолчанию 20. |
| offset | ❌ | integer | Смещение для пагинации. По умолчанию 0. |
| location | ❌ | string | Локация клиента для фильтрации списка. |
Пример запроса
Пример успешного ответа
migrate/get_customers_by_email_list¶
Возвращает список клиентов на основе предоставленного списка Email-адресов.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: get_customers_by_email_list |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| list | ❌ | array<string> | Список email-адресов (разделитель — перенос строки). Принимает несколько значений: list[]=a@b.com&list[]=c@d.com |
| location | ❌ | string | Локация пользователя для фильтрации данных |
Пример запроса
Пример успешного ответа
migrate/get_hosting_to_move¶
Возвращает данные о доступных хостингах (серверах) для миграции в указанной локации.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_hosting_to_move |
| token | ✅ | string | Токен авторизации |
| location | ❌ | string | Идентификатор или название локации для переноса хостинга. |
Пример запроса
Пример успешного ответа
migrate/get_hostings_list¶
Возвращает список хостингов, доступных для миграции в рамках указанной локации.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_hostings_list |
| token | ✅ | string | Токен авторизации |
| id | ❌ | integer | Идентификатор пользователя или сервера для проверки прав доступа |
| location | ❌ | string | Локация хостинга для фильтрации списка |
Пример запроса
Пример успешного ответа
migrate/get_inactive_customers¶
Возвращает список неактивных клиентов с фильтрацией по датам, типам и статусам сервисов.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: get_inactive_customers |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| billing_from | ❌ | string | Дата начала периода (billing_from). |
| billing_to | ❌ | string | Дата окончания периода (billing_to). |
| customer_type | ❌ | string | Тип клиента. |
| service_status | ❌ | string | Статус сервиса. Допустимые значения: active, suspended. |
| search | ❌ | string | Поисковый запрос по клиентам. |
Пример запроса
Пример успешного ответа
migrate/get_migrated_customers¶
Возвращает список клиентов, прошедших процедуру миграции за указанный период.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_migrated_customers |
| date_from | ❌ | string | Дата начала периода миграции. |
| date_to | ❌ | string | Дата окончания периода миграции. |
| search | ❌ | string | Поисковый запрос по клиентам. |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
Пример успешного ответа
migrate/get_order_to_move¶
Возвращает детальную информацию о заказе, доступном для миграции.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: get_order_to_move |
| token | ✅ | string | API-токен аутентификации |
| id | ✅ | integer | Идентификатор объекта (например, сервера или пользователя) для миграции |
| location | ❌ | string | Локация для переноса данных |
Пример запроса
Пример успешного ответа
migrate/get_part_of_list¶
Возвращает фрагмент (страницу) списка клиентов с учетом пагинации.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: get_part_of_list |
|---|---|---|---|
| start | ❌ | integer | Смещение (offset) для пагинации. |
| length | ❌ | integer | Количество записей на страницу. |
| token | ✅ | string | API-токен аутентификации |
| location | ❌ | string | Местоположение или идентификатор локации для получения части списка. |
Пример запроса
migrate/hosting¶
Выполняет миграцию параметров хостинга.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: hosting |
| data | ❌ | array<string> | Дополнительные данные для миграции. |
| hosting | ❌ | integer | ID хостинга (может быть JSON-строкой). |
| orderid | ❌ | integer | ID заказа. |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
Пример успешного ответа
migrate/migrate_inactive_list¶
Запускает процесс миграции неактивных клиентов.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: migrate_inactive_list |
| dry_run | ❌ | boolean | Запуск в тестовом режиме (без реальных изменений). Допустимые значения: 0, 1. |
| billing_from | ❌ | string | Начальная биллинговая локация. |
| billing_to | ❌ | string | Конечная биллинговая локация. |
| customer_ids | ❌ | array<integer> | Список ID клиентов для миграции. |
| customers_data | ❌ | array<string> | Массив данных о клиентах (JSON). |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
Пример успешного ответа
migrate/number_customer_lists¶
Сравнивает количество записей в двух биллинговых локациях.
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: number_customer_lists |
|---|---|---|---|
| billing1 | ❌ | string | Первая биллинговая локация. |
| billing2 | ❌ | string | Вторая биллинговая локация. |
| token | ✅ | string | API-токен аутентификации |
Пример запроса
migrate/put_hosting_to_move¶
Завершает процесс миграции хостинга, обновляет данные в биллинге и логирует изменения.
HTTP-метод: POST
Параметры:
| Параметр | Обязательный | Тип | Описание |
|---|---|---|---|
| action | ✅ | string | Идентификатор метода: put_hosting_to_move |
| ❌ | string | Email клиента. | |
| hosting | ❌ | array<string> | Данные хостинга (JSON-строка). |
| new_amount | ❌ | number | Новая сумма платежа. |
| new_currency | ❌ | string | Новая валюта. |
| component | ❌ | integer | ID компонента (сервера). |
| locationOld | ❌ | string | Старая локация. |
| token | ✅ | string | API-токен аутентификации |
| location | ❌ | string | Целевая локация для переноса хостинга. |
Пример запроса
migrate/rollback_inactive_list¶
Выполняет откат изменений для списка неактивных клиентов. Поддерживает режим пробного запуска (dry run).
HTTP-метод: POST
Параметры:
| action | ✅ | string | Идентификатор метода: rollback_inactive_list |
|---|---|---|---|
| token | ✅ | string | Токен авторизации |
| dry_run | ❌ | boolean | Режим пробного запуска. Допустимые значения: 0, 1. |
| records | ❌ | array<object> | Массив записей для отката (передается в формате JSON) |
Пример запроса