- Navigate to BSS > Setup > System Options > Applications Setup
- Select "Register New Application"
- The new application registration page will be displayed and you must select the following:
- "Application name" and "Description": odix Service Manager.
- "Enable Accounts Management" must be checked.
- "Enable Subscriptions Management" must be checked.
- Save the new application.
The save action generates the "Application Id" and "API key" values that are specific for your installation. These keys are available on the registration page.
- Add in the authentication section the below URLs:
Account Synchronize URL
Subscription Create URL
Subscription Update URL
- Define the endpoints.
You need to contact odix to receive the base URL for the endpoints.
Setup Configuration endpoints Getting Settings Fields: [BASE URL]/Stage/setup/settings
Validate Setting Fields: [BASE URL]/Stage/setup/settings
Get Service Definitions: [BASE URL]/Stage/setup/ServiceDefinitions
Account Management endpoints Account Get Synchronization Options: [BASE URL]/Stage/account/sync
Account Synchronize: [BASE URL]/Stage/account/sync
Account Delete: [BASE URL]/Stage/account/Delete
Account Exists: [BASE URL]/Stage/account/Exists
Subscriptions Management endpoints Subscription Create: [BASE URL]/Stage/subscriptions/create
Subscription Update: [BASE URL]/Stage/subscriptions/update
Subscription Activate: [BASE URL]/Stage/subscriptions/activate
Subscription Suspend: [BASE URL]/Stage/subscriptions/suspend
Subscription Cancel: [BASE URL]/Stage/subscriptions/cancel
Subscription Update to Paid: [BASE URL]/Stage/subscriptions/UpgradeToPaid
The following checkboxes need to be enabled:
- Subscriptions requires Accounts synchronization.
- Send email notification to customer.
- Enable Upgrade to paid on trial subscriptions.
Save the edit page
The odix application service manager is now registered in your BSS and you can activate it by following the instructions described in Activating the Integration with odix page.
Updating the Registration Settings
You can always update the registration settings of odix service manager from the "Edit Integration" button in "Cloud Applications" section.