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 | |
| 3 | GET /api/v3/resellers/:reseller_id/user_authentication/token | Get the authentication token for an Account Owner | ||
| 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 the Reseller's Subscription information by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions/:subscription_id | Get the downstream Reseller's Subscription information by ID | ||
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/subscriptions/:subscription_id | Change the Auto-renew option of the Reseller's 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 the Reseller's Subscription | ||
| 3 | POST /api/v3/resellers/:reseller_id/subscriptions/:subscription_id/activate_operation | Activate the Reseller's 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 a List of the Reseller's Subscriptions | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_subscriptions | Get a List of all downstream Resellers Subscriptions | ||
Account | Create | 1 | POST /api/vendor/v1/accounts.json | Create an Account |
| 3 | POST /api/v3/resellers/:reseller_id/accounts | Create a Reseller's 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 the Reseller's Account Information by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_accounts/:account_id | Get the Child Reseller's Account information by ID | ||
| Update | 1 | PUT /api/vendor/v1/accounts/:account_id | Update an Account | |
| 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id | Update a Reseller's 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 a List of all downstream Resellers Accounts | ||
| 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 a List of the Reseller's 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 | Adding taxes for Charges in Postpay model |
| 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 the downstream Reseller's end-customer Charge information by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges/:charge_id | Get the Reseller's Charge information by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges/:charge_id | Get the downstream Reseller's Charge information by ID | ||
| Update | 3 | PATCH /api/v3/vendor/subscriptions/:subscription_id/close_charges | Close Charges for Subscriptions that were sold by a downline Reseller | |
| 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 a List of all downstream Resellers end-customers Charges | ||
| 3 | GET /api/v3/resellers/:reseller_id/reseller_charges | Get a List of the Reseller's Charges | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_reseller_charges | Get a List of Reseller Charges of all downstream Resellers | ||
Correction | Create | 3 | POST /api/v3/resellers/:reseller_id/corrections | Create a Reseller's Correction |
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/corrections/:correction_id | Update a Reseller's 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 a Sales Order | ||
| 3 | POST /api/v3/resellers/:reseller_id/switch_order | Create a Switch Order | ||
| 3 | POST /api/v3/resellers/:reseller_id/change_order | Create a Change Order | ||
| 3 | POST /api/v3/resellers/:reseller_id/renewal_order | Create a Renewal Order | ||
| 3 | POST /api/v3/resellers/:reseller_id/prolong_order | Create a 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 the Reseller's Order Info by ID | ||
| 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 an Order | ||
| List | 1 | GET /api/vendor/v1/orders.json | Get the List of Orders | |
| 3 | GET /api/v3/resellers/:reseller_id/orders | Get a List of the Reseller's Orders | ||
Payment | Create | 1 | POST /api/vendor/v1/payments.json | Create a Payment |
| 3 | POST /api/v3/resellers/:reseller_id/payments | Create a Reseller's Payment for topping up the Account balance | ||
| 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 the Reseller's Payment information by ID | ||
| Update | 1 | DELETE /api/vendor/v1/payments/:payment_id | Cancel a Payment | |
| 3 | DELETE /api/v3/resellers/:reseller_id/payments/:payment_id | Cancel a Reseller's 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 a Reseller's Payment | ||
| Complete a Reseller's Payment from the Account balance | ||||
| List | 1 | GET /api/vendor/v1/payments.json | Get a List of Payments | |
| 3 | GET api/v3/resellers/:reseller_id/payments | Get a List of the Reseller's 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 the Reseller's Plan information by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans/:plan_id | Get the downstream Reseller's Plan information by ID | ||
| 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 a List of the Reseller's switchable Plans | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/ | Get a List of the Reseller's Plans | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_plans | Get a List of all downstream Resellers Plans | ||
| 3 | GET /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes | Get a List of the Reseller's Plan order attributes | ||
Manager | Create | 3 | POST /api/v3/resellers/:reseller_id/managers | Create a Reseller's 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 the Reseller's Manager by ID | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers/:manager_id | Get the downstream Reseller's Manager by ID | ||
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/managers/:manage_id | Update a Reseller's Manager | |
| List | 1 | GET /api/vendor/v1/managers.json | Get a List of Managers | |
| 3 | GET /api/v3/resellers/:reseller_id/managers | Get a List of the Reseller's Managers | ||
| 3 | GET /api/v3/resellers/:reseller_id/child_reseller_managers | Get a List of all downstream Resellers Managers | ||
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 by ID (Customer Store) |
| 3 | GET /api/v3/resellers/:reseller_id | Get downstream Reseller information by ID | ||
| List | 3 | GET /api/v3/customer_store/resellers | Get Resellers List (Customer Store) | |
| 3 | GET /api/v3/resellers/:reseller_id/child_resellers | Get the downstream Resellers list | ||
Closing document | Create | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices | Send information about a Closing document from an ERP system |
| 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 information about a Closing document | |
| Update | 3 | PATCH /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Update information about a Closing document | |
| Delete | 3 | DELETE /api/v3/resellers/:reseller_id/accounts/:account_id/external_invoices/:external_invoice_id | Delete information about a Closing document | |
| Invoice | Read | 3 | GET /api/v3/resellers/:reseller_id/invoices/:invoice_id | Get Invoice information |
| Update | 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/approve_invoices | Approve a postpaid Invoice of a Reseller Account | |
| 3 | POST /api/v3/resellers/:reseller_id/accounts/:account_id/complete_invoices | Complete a postpaid Invoice of a Reseller Account | ||
| List | 3 | GET /api/v3/resellers/:reseller_id/invoices | Get a List of Reseller's Invoices | |
Products category | List | 3 | GET /api/v3/customer_store/resellers/:reseller_id/product_categories | Get Products 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 Products | |
Reseller's free access document | Create | 3 | POST /api/v3/resellers/:reseller_id/free_access_documents | Create a free access document |
| Update | 3 | PUT /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Update a free access document | |
| Delete | 3 | DELETE /api/v3/resellers/:reseller_id/free_access_documents/:free_access_document_id | Delete a free access document | |
| List | 3 | GET /api/v3/resellers/:reseller_id/free_access_documents | Get a List of the free access documents | |
Discount | Read | 3 | GET /api/v3/resellers/:reseller_id/reseller_discounts | Get information about the best Reseller Discount |
| Asynchronous task | Create | 3 | POST /api/v3/resellers/:reseller_id/plans/:plan_id/order_attributes_validation | Validate the Reseller's Plan order attributes |
| Read | 3 | GET /api/v3/resellers/:reseller_id/async_tasks/:async_task_id | Get information about the Reseller asynchronous task by ID |