Покрытие API функциональности ActivePlatform
В таблице приведен список сущностей ActivePlatform, список возможных действий и соответствующих методов API для выполнения этих действий.
| Сущность | Действие с сущностью | Версия API | Метод | Ссылка на описание метода |
|---|---|---|---|---|
Пользователь User | Создание | 1 | POST /api/vendor/v1/users.json | Создание Пользователя |
| Чтение | 1 | GET /api/vendor/v1/users/:user_id | Получение информации о Пользователе | |
| Обновление | 1 | PUT /api/vendor/v1/users/:user_id | Обновление Пользователя | |
| Список | 1 | GET /api/vendor/v1/users | Получение Cписка пользователей | |
| 1 | GET /api/vendor/v1/users/:user_id/accounts.json | Получение Cписка клиентов по ID пользователя | ||
Подписка Subscription | Чтение | 1 | GET /api/vendor/v1/subscriptions/:subscription_id | Получение информации о Подписке по ID |
| 3 | GET /api/v3/resellers/:reseller_id/subscriptions/:subscription_id | Получение информации о подписке реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions/:subscription_id | Получение информации о подписке нижестоящего реселлера | ||
| Обновление | 3 | PATCH /api/v3/resellers/:reseller_id/subscriptions/:subscription_id | Изменение опции Автопродление для подписки реселлера | |
| 1 | POST /api/vendor/v1/subscriptions/:subscription_id/renew | Продление Подписки | ||
| 1 | POST /api/vendor/v1/subscriptions/:subscription_id/change | Изменение Ресурсов подписки | ||
| 1 | POST api/vendor/v1/subscriptions/:subscription_id/switch.json | Переключение Тарифного плана | ||
| 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/stop_operation | Остановка подписки реселлера | ||
| 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/activate_operation | Активация подписки реселлера | ||
| Удаление | 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/delete_operation | Удаление подписки реселлера | |
| Список | 1 | GET /api/vendor/v1/subscriptions/:subscription_id/resources.json | Получение Списка ресурсов по ID подписки | |
| 1 | GET /api/vendor/v1/subscriptions/:subscription_id/applications.json | Получение Cписка экземпляров услуг по ID подписки | ||
| 1 | GET /api/vendor/v1/subscriptions | Получение списка Подписок | ||
| 3 | GET /api/v3/resellers/:reseller_id/subscriptions | Получение списка подписок реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions | Получение списка подписок всех нижестоящих реселлеров | ||
Клиент Account | Создание | 1 | POST /api/vendor/v1/accounts.json | Создание Клиента (v1) |
| 3 | POST /api/v3/resellers/:reseller_id/accounts | Создание клиента реселлера | ||
| Чтение | 1 | GET /api/vendor/v1/accounts/:account_id | Получение информации о Клиенте | |
| 1 | GET /api/vendor/v1/accounts/:account_id/subscriptions.json | Получение списка Подписок Клиента | ||
| 3 | GET /api/v3/resellers/:reseller_id/accounts/:account_id | Получение информации о клиенте реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_accounts/:account_id | Получение информации о клиенте нижестоящего реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/user_authentication/token | Получение токена аутентификации Владельца аккаунта | ||
| Обновление | 1 | PUT /api/vendor/v1/accounts/:account_id | Обновление информации о Клиенте | |
| 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id | Обновление информации о клиенте реселлера | ||
| 2 | POST /api/v2/vendor/account_accesses.json | Присоединение Пользователя к Клиенту | ||
| 2 | DELETE /api/v2/vendor/account_accesses/detach.json | Отсоединение Пользователя от Клиента | ||
| Список | 1 | GET /api/vendor/v1/accounts.json | Получение списка Клиентов | |
| 3 | GET /api/v3/resellers/:reseller_id/accounts | |||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_accounts | Получение списка клиентов всех нижестоящих реселлеров | ||
| 1 | GET /api/vendor/v1/accounts/:account_id/users.json | Получение Cписка клиентов по ID пользователя | ||
| 3 | GET /api/v3/resellers/:reseller_id/account_attributes | Получение списка параметров клиента реселлера | ||
Тип клиента Account type | Список | 1 | GET /api/client/v1/account_types.json | Получение cписка Типов клиентов |
Домен Domain | Создание | 1 | POST /api/vendor/v1/domains.json | Создание Домена |
| Чтение | 1 | GET /api/vendor/v1/domains/:domain_id | Получение информации о Домене | |
| Обновление | 1 | POST /api/vendor/v1/domains/:domain_id/applications/:application_id | Прикрепление Экземпляра услуги к Домену | |
| 1 | DELETE /api/vendor/v1/domains/:domain_id/applications/:application_id | Отсоединение Экземпляра услуги от Домена | ||
| Удаление | 1 | DELETE /api/vendor/v1/domains/:domain_id | Удаление Домена | |
| Список | 1 | GET /api/vendor/v1/domains.json | Получение Cписка доменов | |
| 1 | GET /api/vendor/v1/domains/:domain_id | Получение Cписка экземпляров услуг домена | ||
Списание Charge | Чтение | 1 | GET /api/reseller/v1/charges/:charge_id | Получение информации о Списании |
| 3 | GET /api/v3/resellers/:reseller_id/charges/:charge_id | Получение информации о списании конечного клиента реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_charges/:charge_id | Получение информации о списании конечного клиента нижестоящего реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges/:charge_id | Получение информации о реселлер-списании реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges/:charge_id | Получение информации о реселлер-списании нижестоящего реселлера по ID | ||
| Обновление | 3 | PATCH /api/v3/vendor/subscriptions/:subscription_id/close_charges | Закрытие списаний по годовым подпискам для партнерских продаж | |
| Список | 1 | GET /api/reseller/v1/charges.json | Получение списка Списаний | |
| 3 | GET /api/v3/resellers/:reseller_id/charges | |||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_charges | Получение списка списаний конечных клиентов всех нижестоящих реселлеров | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges | Получение списка реселлер-списаний реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges | Получение списка реселлер-списаний всех нижестоящих реселлеров | ||
Корректировка Correction | Создание | 3 | POST /api/v3/resellers/:reseller_id/corrections | Создание корректировки реселлера |
| Обновление | 3 | PATCH /api/v3/resellers/:reseller_id/corrections/:correction_id | Подтверждение или отклонение корректировки реселлера | |
| Список | 1 | GET /api/vendor/v1/corrections.json | Получение Cписка корректировок | |
Заказ Order | Создание | 1 | POST /api/vendor/v1/orders.json | Создание Заказа |
| 3 | POST /api/v3/resellers/:reseller_id/sales_order | Создание заказа на покупку | ||
| 3 | POST /api/v3/resellers/:reseller_id/switch_order | Создание заказа на переключение | ||
| 3 | POST /api/v3/resellers/:reseller_id/change_order | Создание заказа на изменение количества ресурсов | ||
| 3 | POST /api/v3/resellers/:reseller_id/renewal_order | Создание заказа на продление | ||
| 3 | POST /api/v3/resellers/:reseller_id/prolong_order | Создание заказа на пролонгацию | ||
| Чтение | 1 | GET /api/vendor/v1/orders/:order_id | Получение информации о Заказе | |
| 3 | GET /api/v3/resellers/:reseller_id/orders/:order_id | Получение информации о заказе реселлера | ||
| Обновление | 1 | PUT /api/vendor/v1/orders/:order_id | Обновление Заказа | |
| 3 | POST /api/v3/resellers/:reseller_id/orders/:order_id/cancel_operation | Отмена заказа | ||
| Список | 1 | GET /api/vendor/v1/orders.json | Получение списка Заказов | |
| 3 | GET /api/v3/resellers/:reseller_id/orders | Получение списка заказов реселлера | ||
Платеж Payment | Создание | 1 | POST /api/vendor/v1/payments.json | Создание Платежа |
| 3 | POST /api/v3/resellers/:reseller_id/payments | Создание платежа реселлера на пополнение баланса клиента | ||
| Чтение | 1 | GET /api/vendor/v1/payments/:payment_id | Получение информации о Платеже | |
| 3 | GET /api/v3/resellers/:reseller_id/payments/:payment_id | Получение информации о платеже реселлера | ||
| Обновление | 1 | DELETE /api/vendor/v1/payments/:payment_id | Отмена Платежа | |
| 3 | DELETE /api/v3/resellers/:reseller_id/payments/:payment_id | Отмена платежа реселлера | ||
| 1 | POST /api/vendor/v1/payments/:payment_id/complete.json | Завершение Платежа | ||
| 2 | PUT /api/v2/vendor/payments/:payment_id/pay_from_balance.json | Оплата Заказа с использованием Баланса клиента | ||
| 3 | PATCH /api/v3/resellers/:reseller_id/payments/:payment_id | Завершение платежа реселлера | ||
| Завершение платежа реселлера с использованием баланса клиента | ||||
| Список | 1 | GET /api/vendor/v1/payments.json | Получение Списка платежей | |
| 3 | GET api/v3/resellers/:reseller_id/payments | Получение списка платежей реселлера | ||
Тарифный план Plan | Чтение | 1 | GET /api/vendor/v1/plans/:plan_id | Получение информации о Тарифном плане |
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id | Получение информации о тарифном плане реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans/:plan_id | Получение информации о тарифном плане нижестоящего реселлера | ||
| Список | 1 | GET /api/vendor/v1/plans.json | Получение Cписка тарифных планов | |
| 2 | Получение списка наиболее доступных для заказа Тарифных планов | |||
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id/switchable_plans | Получение списка переключаемых тарифных планов реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/ | Получение списка тарифных планов реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans | Получение списка тарифных планов всех нижестоящих реселлеров | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes | Получение списка дополнительных параметров услуг для тарифного плана реселлера | ||
Менеджер (Сотрудник) Manager | Создание | 3 | POST /api/v3/resellers/:reseller_id/managers | Создание менеджера реселлера |
| Чтение | 1 | GET /api/vendor/v1/managers/:manager_id | Получение информации о Сотруднике | |
| 3 | GET /api/v3/resellers/:reseller_id/managers/:manager_id | Получение информации о менеджере реселлера по ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers/:manager_id | Получение информации о менеджере нижестоящего реселлера по ID | ||
| Обновление | 3 | PATCH /api/v3/resellers/:reseller_id/managers/:manage_id | Обновление менеджера реселлера | |
| Список | 1 | GET /api/vendor/v1/managers.json | Получение Cписка сотрудников | |
| 3 | GET /api/v3/resellers/:reseller_id/managers | Получение списка менеджеров реселлера | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers | Получение списка менеджеров всех нижестоящих реселлеров | ||
Приложение Application | Чтение | 1 | GET /api/vendor/v1/applications/:application_id | Получение информации об Экземпляре услуги |
| Обновление | 1 | POST /api/vendor/v1/applications/:application_id/domains/:domain_id | Присоединение Домена к Экземпляру услуги | |
| 1 | DELETE /api/vendor/v1/applications/:application_id/domains/:domain_id | Отсоединение Домена от Экземпляра услуги | ||
| Список | 1 | GET /api/vendor/v1/applications.json | Получение Списка экземпляров услуг | |
| 1 | GET /api/vendor/v1/applications/:application_id/domains.json | Получение Списка доменов Экземпляра услуги | ||
Реселлер Reseller | Чтение | 3 | GET /api/v3/customer_store/resellers/:reseller_id | Получение информации о реселлере (Customer Store) |
| 3 | GET /api/v3/resellers/:reseller_id | Получение информации о реселлере | ||
| Список | 3 | GET /api/v3/customer_store/resellers | Получение списка реселлеров (Customer Store) | |
| 3 | GET /api/v3/resellers/:reseller_id/child_resellers | Получение списка нижестоящих реселлеров | ||
Закрывающий документ Closing document | Создание | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices | Отправка информации о закрывающем документе из внешней ERP-системы |
| 3 | POST /api/v3/resellers/:reseller_id/notifications/external_invoices | Отправка уведомлений клиентам реселлера о готовности закрывающих документов | ||
| Чтение | 3 | GET /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices | Получение информации о закрывающем документе | |
| Обновление | 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Обновление информации о закрывающем документе | |
| Удаление | 3 | DELETE /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Удаление информации о закрывающем документе | |
Акт Invoice | Чтение | 3 | GET /api/v3/resellers/:reseller_id/invoices/:invoice_id | Получение информации об акте |
| Обновление | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/approve_invoices | Подтверждение акта по модели Постоплата для клиента реселлера | |
| 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/complete_invoices | Завершение акта по модели Постоплата для клиента реселлера | ||
| 3 | POST /api/v3/resellers/:reseller_id/invoices/:invoice_id/approve | Подтверждение акта по модели Постоплата по ID | ||
| 3 | POST /api/v3/resellers/:reseller_id/invoices/:invoice_id/complete | Завершение акта по модели Постоплата по ID | ||
| Список | 3 | GET /api/v3/resellers/:reseller_id/invoices | Получение списка актов реселлера | |
Категория продуктов Products category | Список | 3 | GET /api/v3/customer_store/resellers/:reseller_id/product_categories | Получение списка категорий продуктов реселлера |
Продукт Product | Чтение | 3 | GET /api/v3/customer_store/resellers/:reseller_id/products/:product_id | Получение информации о продукте реселлера по ID |
| Список | 3 | GET /api/v3/customer_store/resellers/:reseller_id/products | Получение списка продуктов реселлера | |
Документ реселлера с открытым доступом Reseller's free access document | Создание | 3 | POST /api/v3/resellers/:reseller_id/free_access_documents | Создание нового документа с открытым доступом |
| Обновление | 3 | PUT /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Обновление документа с открытым доступом | |
| Удаление | 3 | DELETE /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Удаление документа с открытым доступом | |
| Список | 3 | GET /api/v3/resellers/:reseller_id/free_access_documents | Получение списка документов с открытым доступом | |
Скидка Discount | Чтение | 3 | GET /api/v3/resellers/:reseller_id/reseller_discounts | Получение информации о наилучшей скидке типа Реселлер |
Асинхронная задача Asynchronous task | Создание | 3 | POST /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes_validation | Валидация дополнительных параметров услуг для тарифного плана реселлера |
| Чтение | 3 | GET /api/v3/resellers/:reseller_id/async_tasks/:async_task_id | Получение информации об асинхронной задаче реселлера по ID | |
Курсы валют Currency rates | Список | 3 | GET /api/v3/resellers/:reseller_id/currency_rates | Получение списка курсов валют реселлера |
Комментарии Notes | Создание | 3 | POST {base_url}/api/v3/resellers/{reseller_id}/notes | Создание комментария |
| Чтение | GET {base_url}/api/v3/resellers/{reseller_id}/notes/{note_id} | Получение информации о комментарии | ||
| Удаление | DELETE {base_url}/api/v3/resellers/{reseller_id}/notes/{note_id} | Удаление комментария | ||
| Список | GET {base_url}/api/v3/resellers/{reseller_id}/notes | Получение списка комментариев |