REST API

REST API #

The REST API can be used to automatically provision and manage resellers and reseller users on the ~.Dimensions.~ system. This section of the portal allows the API to be enabled and provides access to the Client Id and Client Secret that are required to request the API's access and refresh tokens.

To enable the API, enterprise portal users need to have the API Administrator role assigned.

Using the REST API #

The REST API provides the tools necessary to automate the Customer onboarding process. Using a standards-based approach and recommended best practices, the REST-based API provides a simple yet powerful and secure way for Service Providers to be able to manage Customers and their ~.Dimensions.~ accounts.

Features #

Some of the features that can be performed include:

  • Manage 'Reseller Accounts'
    • Create accounts
    • Update existing accounts
    • Manage users and permissions
  • Manage 'Customer Accounts' for a reseller
    • Provision new customers
    • Update existing customers
    • Manage users, permissions & softphone devices
    • Enable/disable customers
  • Query Invoices & Billing Data

Getting Started

API Reference