Покрытие 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
Подтверждение акта по IDPOST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/approve
Завершение акта по IDPOST {base_url}/api/v3/resellers/{reseller_id}/invoices/{invoice_id}/complete

Закрывающие документы

РазделДействиеЗапрос
Закрывающие документыОтправка информации о закрывающем документе из внешней 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}
Завершение платежа по IDPATCH {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

Комментарии

РазделДействиеЗапрос
КомментарииСоздание комментария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}

Аналитика