Coverage of the ActivePlatform functionality by API

The following table represents the ActivePlatform entities, available operations for the entities, and the corresponding API methods.

EntityActionAPI versionAPI methodLink to the method description

User

Create1POST /api/vendor/v1/users.jsonCreate a User
Read1GET /api/vendor/v1/users/:user_idGet User Info by ID
Update1PUT /api/vendor/v1/users/:user_idUpdate a User
List1GET /api/vendor/v1/usersGet a List of Users
1GET /api/vendor/v1/users/:user_id/accounts.jsonGet a List of Accounts by a User ID

Subscription

Read1GET /api/vendor/v1/subscriptions/:subscription_idGet Subscription Info by ID
3GET /api/v3/resellers/:reseller_id/subscriptions/:subscription_idGet subscription
3GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions/:subscription_idGet subscription of downstream reseller
Update3PATCH /api/v3/resellers/:reseller_id/subscriptions/:subscription_idChange auto-renew option of subscription
1POST /api/vendor/v1/subscriptions/:subscription_id/renewRenew a Subscription
1POST /api/vendor/v1/subscriptions/:subscription_id/changeChange Subscription's Resources
1POST api/vendor/v1/subscriptions/:subscription_id/switch.jsonSwitch a Plan of the Subscription
3POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/stop_operationStop subscription
3POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/activate_operationActivate subscription
List1GET /api/vendor/v1/subscriptions/:subscription_id/resources.jsonGet a List of Resources by a Subscription ID
1GET /api/vendor/v1/subscriptions/:subscription_id/applications.jsonGet a List of Applications by a Subscription ID
1GET /api/vendor/v1/subscriptionsGet a List of Subscriptions
3GET /api/v3/resellers/:reseller_id/subscriptionsGet list of subscriptions
3GET /api/v3/resellers/:reseller_id/child_reseller_subscriptionsGet list of subscriptions of downstream resellers

Account

Create1POST /api/vendor/v1/accounts.jsonCreate an Account
3POST /api/v3/resellers/:reseller_id/accountsCreate account
Read1GET /api/vendor/v1/accounts/:account_idGet Account Info by ID
1GET /api/vendor/v1/accounts/:account_id/subscriptions.jsonGet Account's Subscriptions by ID
3GET /api/v3/resellers/:reseller_id/accounts/:account_idGet account
3GET /api/v3/resellers/:reseller_id/child_reseller_accounts/:account_idGet account of downstream reseller
3GET /api/v3/resellers/:reseller_id/user_authentication/tokenGet user's auth by token
Update1PUT /api/vendor/v1/accounts/:account_idUpdate an Account
3PATCH /api/v3/resellers/:reseller_id/accounts/:account_idUpdate account
2POST /api/v2/vendor/account_accesses.jsonAttach a User to an Account
2DELETE /api/v2/vendor/account_accesses/detach.jsonDeattach a User from an Account
List1GET /api/vendor/v1/accounts.jsonGet a List of Accounts
3GET /api/v3/resellers/:reseller_id/accounts

Get list of accounts

3GET /api/v3/resellers/:reseller_id/child_reseller_accountsGet list of accounts of downstream resellers
1GET /api/vendor/v1/accounts/:account_id/users.jsonGet a List of Accounts by a User ID
3GET /api/v3/resellers/:reseller_id/account_attributesGet list of account attributes

Account Type

List1GET /api/client/v1/account_types.jsonGet a List of Account Types

Domain

Create1POST /api/vendor/v1/domains.jsonCreate a Domain
Read1GET /api/vendor/v1/domains/:domain_idGet Domain Info by a Domain ID
Update1POST /api/vendor/v1/domains/:domain_id/applications/:application_idAttach an Application to the Domain
1DELETE /api/vendor/v1/domains/:domain_id/applications/:application_idDetach an Application from the Domain
Delete1DELETE /api/vendor/v1/domains/:domain_idDelete a Domain
List1GET /api/vendor/v1/domains.jsonGet a List of Domains
1GET /api/vendor/v1/domains/:domain_idGet a List of Applications by a Domain ID
Tax for a postpaid ChargeCreate3POST /api/v3/resellers/:reseller_id/taxesAdd taxes
ChargeRead1GET /api/reseller/v1/charges/:charge_idGet Charge Info by ID
3GET /api/v3/resellers/:reseller_id/charges/:charge_id

Get end-customer charge

3GET /api/v3/resellers/:reseller_id/child_reseller_charges/:charge_idGet end-customer charge of downstream reseller
3GET /api/v3/resellers/:reseller_id/reseller_charges/:charge_idGet reseller charge
3GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges/:charge_idGet reseller charge of downstream reseller
Update3PATCH /api/v3/vendor/subscriptions/:subscription_id/close_chargesClose charges
List1GET /api/reseller/v1/charges.jsonGet a List of Charges
3GET /api/v3/resellers/:reseller_id/charges

Get list of end-customer charges

3GET /api/v3/resellers/:reseller_id/child_reseller_chargesGet list of end-customer charges of downstream resellers
3GET /api/v3/resellers/:reseller_id/reseller_chargesGet list of reseller charges
3GET /api/v3/resellers/:reseller_id/child_reseller_reseller_chargesGet list of reseller charges of downstream resellers

Correction

Create3POST /api/v3/resellers/:reseller_id/correctionsCreate correction
Update3PATCH /api/v3/resellers/:reseller_id/corrections/:correction_idUpdate correction status
List1GET /api/vendor/v1/corrections.jsonGet a List of Corrections

Order

Create1POST /api/vendor/v1/orders.jsonCreate an Order
3POST /api/v3/resellers/:reseller_id/sales_orderCreate sales order
3POST /api/v3/resellers/:reseller_id/switch_orderCreate switch order
3POST /api/v3/resellers/:reseller_id/change_orderCreate change order
3POST /api/v3/resellers/:reseller_id/renewal_orderCreate renewal order
3POST /api/v3/resellers/:reseller_id/prolong_orderCreate prolong order
Read1GET /api/vendor/v1/orders/:order_idGet Order Info by ID
3GET /api/v3/resellers/:reseller_id/orders/:order_idGet order
Update1PUT /api/vendor/v1/orders/:order_idUpdate an Order
3POST /api/v3/resellers/:reseller_id/orders/:order_id/cancel_operationCancel order
List1GET /api/vendor/v1/orders.jsonGet the List of Orders
3GET /api/v3/resellers/:reseller_id/ordersGet list of orders

Payment

Create1POST /api/vendor/v1/payments.jsonCreate a Payment
3POST /api/v3/resellers/:reseller_id/paymentsCreate payment
Read1GET /api/vendor/v1/payments/:payment_idGet Payment Info by ID
3GET /api/v3/resellers/:reseller_id/payments/:payment_idGet payment
Update1DELETE /api/vendor/v1/payments/:payment_idCancel a Payment
3DELETE /api/v3/resellers/:reseller_id/payments/:payment_idCancel payment
1POST /api/vendor/v1/payments/:payment_id/complete.jsonComplete a Payment
2PUT /api/v2/vendor/payments/:payment_id/pay_from_balance.jsonPay for an Order from an Account Balance
3PATCH /api/v3/resellers/:reseller_id/payments/:payment_idComplete payment
Complete payment from balance
List1GET /api/vendor/v1/payments.jsonGet a List of Payments
3GET api/v3/resellers/:reseller_id/paymentsGet list of payments
PlanRead1GET /api/vendor/v1/plans/:plan_idGet Plan Info by ID
3GET /api/v3/resellers/:reseller_id/plans/:plan_idGet plan
3GET /api/v3/resellers/:reseller_id/child_reseller_plans/:plan_idGet plan of downstream reseller
List1GET /api/vendor/v1/plans.jsonGet a List of Plans
2

GET /api/v2/client/market.json

Get a List of Plans for Marketplace
3GET /api/v3/resellers/:reseller_id/plans/:plan_id/switchable_plansGet list of switchable plans
3GET /api/v3/resellers/:reseller_id/plans/Get list of plans
3GET /api/v3/resellers/:reseller_id/child_reseller_plansGet list of plans of downstream resellers
3GET /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributesGet list of order attributes of plan

Manager

Create3POST /api/v3/resellers/:reseller_id/managersCreate manager
Read1GET /api/vendor/v1/managers/:manager_idGet Manager Info by ID
3GET /api/v3/resellers/:reseller_id/managers/:manager_idGet manager
3GET /api/v3/resellers/:reseller_id/child_reseller_managers/:manager_idGet manager of downstream reseller
Update3PATCH /api/v3/resellers/:reseller_id/managers/:manage_idUpdate manager
List1GET /api/vendor/v1/managers.jsonGet a List of Managers
3GET /api/v3/resellers/:reseller_id/managersGet list of managers
3GET /api/v3/resellers/:reseller_id/child_reseller_managersGet list of managers of downstream resellers

Application

Read1GET /api/vendor/v1/applications/:application_idGet Application Info by ID
Update1POST /api/vendor/v1/applications/:application_id/domains/:domain_idAttach a Domain to an Application
1DELETE /api/vendor/v1/applications/:application_id/domains/:domain_idDetach a Domain from an Application
List1GET /api/vendor/v1/applications.jsonGet a List of Applications
1GET /api/vendor/v1/applications/:application_id/domains.jsonGet a List of Domains by Application ID

Reseller

Read3GET /api/v3/customer_store/resellers/:reseller_idGet reseller (Customer Store)
3GET /api/v3/resellers/:reseller_idGet downstream reseller
List3GET /api/v3/customer_store/resellersGet list of resellers (Customer Store)
3GET /api/v3/resellers/:reseller_id/child_resellersGet list of downstream resellers

Closing document

Create3POST /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoicesSend closing document from ERP
3POST /api/v3/resellers/:reseller_id/notifications/external_invoicesSend notifications on closing documents
Read3GET /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoicesGet closing document
Update3PATCH /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_idUpdate closing document
Delete3DELETE /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_idDelete closing document
InvoiceRead3GET /api/v3/resellers/:reseller_id/invoices/:invoice_idGet invoice
Update3POST /api/v3/resellers/:reseller_id/accounts/:account_id/approve_invoicesApprove invoice
3POST /api/v3/resellers/:reseller_id/accounts/:account_id/complete_invoicesComplete invoice
List3GET /api/v3/resellers/:reseller_id/invoicesGet list of invoices

Products category

List3GET /api/v3/customer_store/resellers/:reseller_id/product_categoriesGet list of product categories

Product

Read3GET /api/v3/customer_store/resellers/:reseller_id/products/:product_idGet product
List3GET /api/v3/customer_store/resellers/:reseller_id/productsGet list of products

Reseller's free access document

Create3POST /api/v3/resellers/:reseller_id/free_access_documentsCreate free access document
Update3PUT /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_idUpdate free access document
Delete3DELETE /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_idDelete free access document
List3GET /api/v3/resellers/:reseller_id/free_access_documentsGet list of free access documents

Discount

Read3GET /api/v3/resellers/:reseller_id/reseller_discountsGet best reseller discount
Asynchronous taskCreate3POST /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes_validationValidate order attributes of plan
Read3GET /api/v3/resellers/:reseller_id/async_tasks/:async_task_idGet async task

ะžั‚ะทั‹ะฒ | Feedback