Покрытие API функциональности ActivePlatform
В таблицах приведен список возможных действий над сущностями и соответствующих API-запросов:
Реселлеры
| Раздел | Действие | Запрос |
|---|---|---|
| Реселлеры | Получение списка нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_resellers |
| Получение списка реселлеров (Customer Store) | GET {base_url}/api/v3/customer_store/resellers | |
| Получение информации о реселлере | GET {base_url}/api/v3/resellers/{reseller_id} | |
| Получение информации о реселлере (Customer Store) | GET /api/v3/customer_store/resellers/{reseller_id} |
Клиенты
| Раздел | Действие | Запрос |
|---|---|---|
| Клиенты | Создание клиента | POST {base_url}/api/v3/resellers/{reseller_id}/accounts |
| Обновление информации о клиенте | PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id} | |
| Получение списка клиентов | GET {base_url}/api/v3/resellers/{reseller_id}/accounts | |
| Получение информации о клиенте | GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id} | |
| Получение списка клиентов всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_accounts | |
| Получение информации о клиенте нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_accounts/{account_id} | |
| Получение токена аутентификации Владельца аккаунта | GET {base_url}/api/v3/resellers/{reseller_id}/user_authentication/token | |
| Получение списка параметров клиента | GET {base_url}/api/v3/resellers/{reseller_id}/account_attributes |
Категории продуктов
| Раздел | Действие | Запрос |
|---|---|---|
| Категории продуктов | Получение списка категорий продуктов | GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/product_categories |
Продукты
| Раздел | Действие | Запрос |
|---|---|---|
| Продукты | Получение списка продуктов | GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products |
| Получение информации о продукте | GET {base_url}/api/v3/customer_store/resellers/{reseller_id}/products/{product_id} |
Тарифные планы
| Раздел | Действие | Запрос |
|---|---|---|
| Тарифные планы | Получение списка тарифных планов | GET {base_url}/api/v3/resellers/{reseller_id}/plans |
| Получение информации о тарифном плане | GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id} | |
| Получение списка тарифных планов всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans | |
| Получение информации о тарифном плане нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_plans/{plan_id} | |
| Получение списка переключаемых тарифных планов | GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/switchable_plans | |
| Получение списка дополнительных параметров услуг для тарифного плана | GET {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/order_attributes | |
| Валидация дополнительных параметров услуг для тарифного плана | POST {base_url}/api/v3/resellers/{reseller_id}/plans/{plan_id}/order_attributes_validation |
Заказы
| Раздел | Действие | Запрос |
|---|---|---|
| Заказы | Получение списка заказов | GET {base_url}/api/v3/resellers/{reseller_id}/orders |
| Получение информации о заказе | GET {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id} | |
| Создание заказа на покупку | POST {base_url}/api/v3/resellers/{reseller_id}/sales_order | |
| Создание заказа на переключение | POST {base_url}/api/v3/resellers/{reseller_id}/switch_order | |
| Создание заказа на изменение количества ресурсов | POST {base_url}/api/v3/resellers/{reseller_id}/change_order | |
| Создание заказа на продление | POST {base_url}/api/v3/resellers/{reseller_id}/renewal_order | |
| Создание заказа на пролонгацию | POST {base_url}/api/v3/resellers/{reseller_id}/prolong_order | |
| Отмена заказа | POST {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}/cancel_operation |
Подписки
| Раздел | Действие | Запрос |
|---|---|---|
| Подписки | Получение списка подписок | GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions |
| Получение информации о подписке | GET {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id} | |
| Получение списка подписок всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptions | |
| Получение информации о подписке нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptions/{subscription_id} | |
| Остановка подписки | POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/stop_operation | |
| Активация подписки | POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/activate_operation | |
| Обновление подписки | PATCH {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id} | |
| Удаление подписки | POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/delete_operation |
Списания
| Раздел | Действие | Запрос |
|---|---|---|
| Списания | Получение списка списаний конечных клиентов | GET {base_url}/api/v3/resellers/{reseller_id}/charges |
| Получение информации о списании конечного клиента | GET {base_url}/api/v3/resellers/{reseller_id}/charges/{charge_id} | |
| Получение списка списаний конечных клиентов всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_charges | |
| Получение информации о списании конечного клиента нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_charges/{charge_id} | |
| Получение списка реселлер-списаний | GET {base_url}/api/v3/resellers/{reseller_id}/reseller_charges | |
| Получение информации о реселлер-списании | GET {base_url}/api/v3/resellers/{reseller_id}/reseller_charges/{charge_id} | |
| Получение списка реселлер-списаний всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_reseller_charges | |
| Получение информации о реселлер-списании нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_reseller_charges/{charge_id} | |
| Добавление налогов для списаний в модели Постоплата | POST {base_url}/api/v3/resellers/{reseller_id}/taxes | |
| Закрытие списаний | PATCH {base_url}/api/v3/vendor/subscriptions/{subscription_id}/close_charges |
Корректировки
| Раздел | Действие | Запрос |
|---|---|---|
| Корректировки | Создание корректировки | POST {base_url}/api/v3/resellers/{reseller_id}/corrections |
| Подтверждение или отклонение корректировки | PATCH {base_url}/api/v3/resellers/{reseller_id}/corrections/{correction_id} |
Скидки
| Раздел | Действие | Запрос |
|---|---|---|
| Скидки | Получение информации о наилучшей скидке типа Реселлер | GET {base_url}/api/v3/resellers/{reseller_id}/reseller_discounts |
Акты
| Раздел | Действие | Запрос |
|---|---|---|
| Акты | Получение списка актов | GET {base_url}/api/v3/resellers/{reseller_id}/invoices |
| Получение информации об акте | GET {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id} |
Акты с внешним управлением
| Раздел | Действие | Запрос |
|---|---|---|
| Акты с внешним управлением | Подтверждение акта | POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/approve_invoices |
| Завершение акта | POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/complete_invoices | |
| Подтверждение акта по ID | POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/approve | |
| Завершение акта по ID | POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/complete | |
| Аннулирование подтверждения акта по ID | POST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/revoke |
Закрывающие документы
| Раздел | Действие | Запрос |
|---|---|---|
| Закрывающие документы | Отправка информации о закрывающем документе из внешней ERP-системы | POST {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices |
| Получение информации о закрывающем документе | GET {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices?filter[key]=key | |
| Обновление информации о закрывающем документе | PATCH {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id} | |
| Удаление информации о закрывающем документе | DELETE {base_url}/api/v3/resellers/{reseller_id}/accounts/{account_id}/external_invoices/{external_invoice_id} | |
| Отправка уведомлений клиентам реселлера о готовности закрывающих документов | POST {base_url}/api/v3/resellers/{reseller_id}/notifications/external_invoices |
Менеджеры
| Раздел | Действие | Запрос |
|---|---|---|
| Менеджеры | Создание менеджера | POST {base_url}/api/v3/resellers/{reseller_id}/managers |
| Обновление информации о менеджере | PATCH {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id} | |
| Получение списка менеджеров | GET {base_url}/api/v3/resellers/{reseller_id}/managers | |
| Получение информации о менеджере | GET {base_url}/api/v3/resellers/{reseller_id}/managers/{manager_id} | |
| Получение списка менеджеров всех нижестоящих реселлеров | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_managers | |
| Получение информации о менеджере нижестоящего реселлера | GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_managers/{manager_id} | |
| Получение списка ролей менеджеров | GET {base_url}/api/v3/resellers/{reseller_id}/manager_roles |
Платежи
| Раздел | Действие | Запрос |
|---|---|---|
| Платежи | Создание платежа на пополнение баланса клиента | POST {base_url}/api/v3/resellers/{reseller_id}/payments |
| Получение списка платежей | GET {base_url}/api/v3/resellers/{reseller_id}/payments | |
| Получение информации о платеже | GET {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id} | |
| Отмена платежа | DELETE {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id} | |
| Завершение платежа по ID | PATCH {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id} | |
| Завершение платежа с использованием баланса клиента | PATCH {base_url}/api/v3/resellers/{reseller_id}/payments/{payment_id} | |
| Завершение платежа по номеру | POST {base_url}/api/v3/resellers/{reseller_id}/payments/{document_id} |
Документы с открытым доступом
| Раздел | Действие | Запрос |
|---|---|---|
| Документы с открытым доступом | Создание документа с открытым доступом | POST {base_url}/api/v3/resellers/{reseller_id}/free_access_documents |
| Обновление документа с открытым доступом | PUT {base_url}/api/v3/resellers/{reseller_id}/free_access_documents/{free_access_document_id} | |
| Получение списка документов с открытым доступом | GET {base_url}/api/v3/resellers/{reseller_id}/free_access_documents | |
| Удаление документа с открытым доступом | DELETE {base_url}/api/v3/resellers/{reseller_id}/free_access_documents/{free_access_document_id} |
Асинхронные задачи
| Раздел | Действие | Запрос |
|---|---|---|
| Асинхронные задачи | Получение информации об асинхронной задаче | GET {base_url}/api/v3/resellers/{reseller_id}/async_tasks/{async_task_id} |
Курсы валют
| Раздел | Действие | Запрос |
|---|---|---|
| Курсы валют | Получение списка курсов валют | GET {base_url}/api/v3/resellers/{reseller_id}/currency_rates |
| Обновление курсов валют | PATCH {base_url}/api/v3/resellers/{reseller_id}/currency_rates |
Комментарии
| Раздел | Действие | Запрос |
|---|---|---|
| Комментарии | Создание комментария | POST {base_url}/api/v3/resellers/{reseller_id}/notes |
| Получение списка комментариев | GET {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}/reseller_analytics |
| Получение предварительной дневной аналитики по подписке | GET {base_url}/api/v3/analytics_daily_drafts | |
| Получение дневной аналитики по подписке | GET {base_url}/api/v3/analytics_daily | |
| Получение месячной аналитики по подписке | GET {base_url}/api/v3/analytics_monthly |