Coverage of the ActivePlatform functionality by API
The following table represents the ActivePlatform entities, available operations for the entities, and the corresponding API methods.
| Entity | Action | API version | API method | Link to the method description |
|---|---|---|---|---|
User | Create | 1 | POST /api/vendor/v1/users.json | Create a User |
| Read | 1 | GET /api/vendor/v1/users/:user_id | Get User Info by ID | |
| Update | 1 | PUT /api/vendor/v1/users/:user_id | Update a User | |
| List | 1 | GET /api/vendor/v1/users | Get a List of Users | |
| 1 | GET /api/vendor/v1/users/:user_id/accounts.json | Get a List of Accounts by a User ID | ||
Subscription | Read | 1 | GET /api/vendor/v1/subscriptions/:subscription_id | Get Subscription Info by ID |
| 3 | GET /api/v3/resellers/:reseller_id/subscriptions/:subscription_id | Get subscription | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions/:subscription_id | Get subscription of downstream reseller | ||
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/subscriptions/:subscription_id | Change auto-renew option of subscription | |
| 1 | POST /api/vendor/v1/subscriptions/:subscription_id/renew | Renew a Subscription | ||
| 1 | POST /api/vendor/v1/subscriptions/:subscription_id/change | Change Subscription's Resources | ||
| 1 | POST api/vendor/v1/subscriptions/:subscription_id/switch.json | Switch a Plan of the Subscription | ||
| 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/stop_operation | Stop subscription | ||
| 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/activate_operation | Activate subscription | ||
| Delete | 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/delete_operation | Delete subscription | |
| List | 1 | GET /api/vendor/v1/subscriptions/:subscription_id/resources.json | Get a List of Resources by a Subscription ID | |
| 1 | GET /api/vendor/v1/subscriptions/:subscription_id/applications.json | Get a List of Applications by a Subscription ID | ||
| 1 | GET /api/vendor/v1/subscriptions | Get a List of Subscriptions | ||
| 3 | GET /api/v3/resellers/:reseller_id/subscriptions | Get list of subscriptions | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions | Get list of subscriptions of downstream resellers | ||
Account | Create | 1 | POST /api/vendor/v1/accounts.json | Create an Account |
| 3 | POST /api/v3/resellers/:reseller_id/accounts | Create account | ||
| Read | 1 | GET /api/vendor/v1/accounts/:account_id | Get Account Info by ID | |
| 1 | GET /api/vendor/v1/accounts/:account_id/subscriptions.json | Get Account's Subscriptions by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/accounts/:account_id | Get account | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_accounts/:account_id | Get account of downstream reseller | ||
| 3 | GET /api/v3/resellers/:reseller_id/user_authentication/token | Get user's auth by token | ||
| Update | 1 | PUT /api/vendor/v1/accounts/:account_id | Update an Account | |
| 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id | Update account | ||
| 2 | POST /api/v2/vendor/account_accesses.json | Attach a User to an Account | ||
| 2 | DELETE /api/v2/vendor/account_accesses/detach.json | Deattach a User from an Account | ||
| List | 1 | GET /api/vendor/v1/accounts.json | Get a List of Accounts | |
| 3 | GET /api/v3/resellers/:reseller_id/accounts | |||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_accounts | Get list of accounts of downstream resellers | ||
| 1 | GET /api/vendor/v1/accounts/:account_id/users.json | Get a List of Accounts by a User ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/account_attributes | Get list of account attributes | ||
Account Type | List | 1 | GET /api/client/v1/account_types.json | Get a List of Account Types |
Domain | Create | 1 | POST /api/vendor/v1/domains.json | Create a Domain |
| Read | 1 | GET /api/vendor/v1/domains/:domain_id | Get Domain Info by a Domain ID | |
| Update | 1 | POST /api/vendor/v1/domains/:domain_id/applications/:application_id | Attach an Application to the Domain | |
| 1 | DELETE /api/vendor/v1/domains/:domain_id/applications/:application_id | Detach an Application from the Domain | ||
| Delete | 1 | DELETE /api/vendor/v1/domains/:domain_id | Delete a Domain | |
| List | 1 | GET /api/vendor/v1/domains.json | Get a List of Domains | |
| 1 | GET /api/vendor/v1/domains/:domain_id | Get a List of Applications by a Domain ID | ||
| Tax for a postpaid Charge | Create | 3 | POST /api/v3/resellers/:reseller_id/taxes | Add taxes |
| Charge | Read | 1 | GET /api/reseller/v1/charges/:charge_id | Get Charge Info by ID |
| 3 | GET /api/v3/resellers/:reseller_id/charges/:charge_id | |||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_charges/:charge_id | Get end-customer charge of downstream reseller | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges/:charge_id | Get reseller charge | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges/:charge_id | Get reseller charge of downstream reseller | ||
| Update | 3 | PATCH /api/v3/vendor/subscriptions/:subscription_id/close_charges | Close charges | |
| List | 1 | GET /api/reseller/v1/charges.json | Get a List of Charges | |
| 3 | GET /api/v3/resellers/:reseller_id/charges | |||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_charges | Get list of end-customer charges of downstream resellers | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges | Get list of reseller charges | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges | Get list of reseller charges of downstream resellers | ||
Correction | Create | 3 | POST /api/v3/resellers/:reseller_id/corrections | Create correction |
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/corrections/:correction_id | Update correction status | |
| List | 1 | GET /api/vendor/v1/corrections.json | Get a List of Corrections | |
Order | Create | 1 | POST /api/vendor/v1/orders.json | Create an Order |
| 3 | POST /api/v3/resellers/:reseller_id/sales_order | Create sales order | ||
| 3 | POST /api/v3/resellers/:reseller_id/switch_order | Create switch order | ||
| 3 | POST /api/v3/resellers/:reseller_id/change_order | Create change order | ||
| 3 | POST /api/v3/resellers/:reseller_id/renewal_order | Create renewal order | ||
| 3 | POST /api/v3/resellers/:reseller_id/prolong_order | Create prolong order | ||
| Read | 1 | GET /api/vendor/v1/orders/:order_id | Get Order Info by ID | |
| 3 | GET /api/v3/resellers/:reseller_id/orders/:order_id | Get order | ||
| Update | 1 | PUT /api/vendor/v1/orders/:order_id | Update an Order | |
| 3 | POST /api/v3/resellers/:reseller_id/orders/:order_id/cancel_operation | Cancel order | ||
| List | 1 | GET /api/vendor/v1/orders.json | Get the List of Orders | |
| 3 | GET /api/v3/resellers/:reseller_id/orders | Get list of orders | ||
Payment | Create | 1 | POST /api/vendor/v1/payments.json | Create a Payment |
| 3 | POST /api/v3/resellers/:reseller_id/payments | Create payment | ||
| Read | 1 | GET /api/vendor/v1/payments/:payment_id | Get Payment Info by ID | |
| 3 | GET /api/v3/resellers/:reseller_id/payments/:payment_id | Get payment | ||
| Update | 1 | DELETE /api/vendor/v1/payments/:payment_id | Cancel a Payment | |
| 3 | DELETE /api/v3/resellers/:reseller_id/payments/:payment_id | Cancel payment | ||
| 1 | POST /api/vendor/v1/payments/:payment_id/complete.json | Complete a Payment | ||
| 2 | PUT /api/v2/vendor/payments/:payment_id/pay_from_balance.json | Pay for an Order from an Account Balance | ||
| 3 | PATCH /api/v3/resellers/:reseller_id/payments/:payment_id | Complete payment | ||
| Complete payment from balance | ||||
| List | 1 | GET /api/vendor/v1/payments.json | Get a List of Payments | |
| 3 | GET api/v3/resellers/:reseller_id/payments | Get list of payments | ||
| Plan | Read | 1 | GET /api/vendor/v1/plans/:plan_id | Get Plan Info by ID |
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id | Get plan | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans/:plan_id | Get plan of downstream reseller | ||
| List | 1 | GET /api/vendor/v1/plans.json | Get a List of Plans | |
| 2 | Get a List of Plans for Marketplace | |||
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id/switchable_plans | Get list of switchable plans | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/ | Get list of plans | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans | Get list of plans of downstream resellers | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes | Get list of order attributes of plan | ||
Manager | Create | 3 | POST /api/v3/resellers/:reseller_id/managers | Create manager |
| Read | 1 | GET /api/vendor/v1/managers/:manager_id | Get Manager Info by ID | |
| 3 | GET /api/v3/resellers/:reseller_id/managers/:manager_id | Get manager | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers/:manager_id | Get manager of downstream reseller | ||
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/managers/:manage_id | Update manager | |
| List | 1 | GET /api/vendor/v1/managers.json | Get a List of Managers | |
| 3 | GET /api/v3/resellers/:reseller_id/managers | Get list of managers | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers | Get list of managers of downstream resellers | ||
Application | Read | 1 | GET /api/vendor/v1/applications/:application_id | Get Application Info by ID |
| Update | 1 | POST /api/vendor/v1/applications/:application_id/domains/:domain_id | Attach a Domain to an Application | |
| 1 | DELETE /api/vendor/v1/applications/:application_id/domains/:domain_id | Detach a Domain from an Application | ||
| List | 1 | GET /api/vendor/v1/applications.json | Get a List of Applications | |
| 1 | GET /api/vendor/v1/applications/:application_id/domains.json | Get a List of Domains by Application ID | ||
Reseller | Read | 3 | GET /api/v3/customer_store/resellers/:reseller_id | Get reseller (Customer Store) |
| 3 | GET /api/v3/resellers/:reseller_id | Get downstream reseller | ||
| List | 3 | GET /api/v3/customer_store/resellers | Get list of resellers (Customer Store) | |
| 3 | GET /api/v3/resellers/:reseller_id/child_resellers | Get list of downstream resellers | ||
Closing document | Create | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices | Send closing document from ERP |
| 3 | POST /api/v3/resellers/:reseller_id/notifications/external_invoices | Send notifications on closing documents | ||
| Read | 3 | GET /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices | Get closing document | |
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Update closing document | |
| Delete | 3 | DELETE /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Delete closing document | |
| Invoice | Read | 3 | GET /api/v3/resellers/:reseller_id/invoices/:invoice_id | Get invoice |
| Update | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/approve_invoices | Approve postpaid invoice | |
| 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/complete_invoices | Complete postpaid invoice | ||
| 3 | POST /api/v3/resellers/:reseller_id/invoices/:invoice_id/approve | Approve postpaid invoice by ID | ||
| 3 | POST /api/v3/resellers/:reseller_id/invoices/:invoice_id/complete | Complete postpaid invoice by ID | ||
| List | 3 | GET /api/v3/resellers/:reseller_id/invoices | Get list of invoices | |
Products category | List | 3 | GET /api/v3/customer_store/resellers/:reseller_id/product_categories | Get list of product categories |
Product | Read | 3 | GET /api/v3/customer_store/resellers/:reseller_id/products/:product_id | Get product |
| List | 3 | GET /api/v3/customer_store/resellers/:reseller_id/products | Get list of products | |
Reseller's free access document | Create | 3 | POST /api/v3/resellers/:reseller_id/free_access_documents | Create free access document |
| Update | 3 | PUT /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Update free access document | |
| Delete | 3 | DELETE /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Delete free access document | |
| List | 3 | GET /api/v3/resellers/:reseller_id/free_access_documents | Get list of free access documents | |
Discount | Read | 3 | GET /api/v3/resellers/:reseller_id/reseller_discounts | Get best reseller discount |
| Asynchronous task | Create | 3 | POST /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes_validation | Validate order attributes of plan |
| Read | 3 | GET /api/v3/resellers/:reseller_id/async_tasks/:async_task_id | Get async task | |
| Currency rates | List | 3 | GET /api/v3/resellers/:reseller_id/currency_rates | Get list of currency rates |