Overview
The Axxess Services and Products collector retrieves client service allocation and subscription data from the Axxess Reseller Control Panel (RCP) platform using the Axxess REST API.
This collector provides visibility into active client services, product subscriptions, and recent service changes across all managed clients, enabling resellers to validate allocations, reconcile usage, and bill customers within Varibill.
The collector retrieves unrated allocation data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.
This is a point-in-time collector, meaning each execution retrieves the current state of client services and allocations at the time of collection. The collector also captures recent service change records (topups) for the current and previous months.
For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector
Collector Summary
| Field | Value |
|---|---|
| Source Collector Name | Axxess Services and Products - Version 7.1 |
| Collection Behavior | Point in Time |
| Rating Model | Unrated |
| Vendor Name | Axxess |
| Product | Axxess Reseller Control Panel (RCP) |
| Purpose | Retrieves client service allocation and subscription data from the Axxess Reseller Control Panel for billing and validation within Varibill |
About Axxess
Axxess is a South African internet service provider and telecommunications company that provides connectivity products and services including mobile data, fibre, ADSL, LTE, VoIP, and fixed wireless solutions.
The Axxess Reseller Control Panel (RCP) is a management platform for Axxess resellers and channel partners. It enables resellers to manage their client base, provision services, monitor subscriptions, and track product allocations across their customer portfolio.
Resellers use the RCP to manage client accounts, assign and monitor service subscriptions, view product catalogues, and track service changes such as topups and upgrades for their customers.
Data Collected
The Axxess Services and Products - Version 7.1 collector retrieves unrated service allocation data from the Axxess Reseller Control Panel. The collector captures two categories of data:
Active Service Records
For each active client, the collector retrieves the current state of their subscribed services. Each record represents a service allocation — a product or subscription assigned to a client.
The collector processes the following data for each active service:
- Client details — client name, site or branch name, and client identifier
- Product details — the product associated with the service, resolved from the Axxess product catalogue where available
- Service quantity — the current quantity allocated for the service
- Service status — only active, non-suspended services are included
The following filtering is applied during processing:
- Only active clients are included (inactive clients are excluded)
- Services with a suspend reason of 3 are excluded
- Only standalone services are included (linked or bundled child services are excluded)
Service Change Records (Topups)
For each active service, the collector also retrieves service change history for the current and previous months. Only changes of type Topup are included. These records capture recent service additions or modifications and are submitted as separate allocation records.
Note: The Axxess Services and Products - Version 7.1 collector reflects the state of the Axxess platform at the time it runs. More frequent execution improves billing accuracy for environments with frequent service or subscription changes.
Prerequisites
Before configuring this collector, ensure that:
- You have an Axxess reseller account with access to the Reseller Control Panel (RCP)
- You have API authentication credentials (API username and password) provided by Axxess for REST API access
- You have client login credentials (client username and password) for your reseller account
- You have noted the API host URL for your Axxess RCP environment
- You have access to the Varibill Source Collector configuration screen
Tip: The API host URL is the base URL of the Axxess Reseller Control
Panel. For example: https://rcp.axxess.co.za/. Include the
trailing slash. Confirm the correct URL with your Axxess account
representative if you are unsure.
Warning! This collector requires two sets of credentials: API authentication credentials and client login credentials. Both must be valid for the collector to function. Store all credentials securely and do not share them. If any credentials are compromised, contact Axxess to revoke and regenerate them immediately.
Configuration Parameters
The parameters below are entered when configuring the collector in Varibill. They are grouped by function.
Connection Parameters
These parameters identify and authenticate against your Axxess Reseller Control Panel environment. The collector uses a two-level authentication model: API-level authentication (HTTP Basic Auth) and a client-level session login.
| Parameter | What it is | Where to find it |
|---|---|---|
| Axxess API Authentication User | The username for HTTP Basic Authentication against the Axxess API | Provided by Axxess for reseller API access |
| Axxess API Authentication Password | The password for HTTP Basic Authentication against the Axxess API | Provided by Axxess for reseller API access |
| Axxess API Host | The base URL of the Axxess Reseller Control Panel API | Your Axxess RCP environment URL. Format:
https://rcp.axxess.co.za/ (include https://
and trailing slash) |
| Axxess Client User | The client username used to establish an API session | Your reseller client login username, provided during Axxess reseller onboarding |
| Axxess Client Password | The client password used to establish an API session | Your reseller client login password |
Warning! The Axxess API Authentication Password and Axxess Client Password are sensitive credentials. They are masked in the Varibill UI once saved. If either credential is compromised, contact Axxess to revoke and regenerate it immediately.
Billing Parameters
These parameters control how Product Identifiers and Record Identifiers are constructed in the data submitted to Varibill.
| Parameter | What it is | Default |
|---|---|---|
| Use Description as Product Identifier | When set to true, the human-readable product
description (for example, MTN data 2.5GB) is used as the
Product Identifier for all service records. When set to
false, the Axxess product GUID is used as the Product
Identifier where available, with a fallback to the product description
when the GUID is not present. |
false |
| Include Client Name in Record Identifier | When set to true, the Record Identifier includes the
client name and site name as a prefix (for example,
Pick And Pay Galleria - MTN data 2.5GB). When set to
false, the Record Identifier contains only the product
name. |
false |
Note: Product Identifiers and Client Identifiers are constructed as follows:
- Client Identifiers are constructed in the format
{client name}#{site name}#{client GUID}— for example,Pick And Pay#Galleria#38c544f2-ab67-11e6-8d43-000c2994d8d2. - Product Identifiers for active service records
depend on the Use Description as Product Identifier
setting. When set to
true, the product description text is used. When set tofalse, the Axxess product GUID is used (with a fallback to the description if the GUID is not available). - Product Identifiers for topup service change
records are constructed in the format
Topup#{change product GUID}.
Ensure your Varibill product configuration accounts for these formats.
Operational Parameters
These parameters control file management behavior.
| Parameter | What it is | Default |
|---|---|---|
| Delete data files older than | The number of days after which locally stored collection files are automatically deleted | 62 |
| Maximum number of records per file | The maximum number of records written to a single output file before a new file is started | 10000 |
Axxess References
The following resources may assist with locating values or configuring your Axxess reseller access.
Axxess Documentation (External)
- Axxess Website
- Axxess Reseller API Documentation - Axxess API Documentation is gated behind a Business Partner Control login. Access should be requested directly from this Vendor.
Note: Axxess documentation is provided for reference. Steps and interface labels may vary depending on your reseller account configuration and permissions.
Configuration Steps
Step 1: Prepare Your Axxess Environment
- Log in to the Axxess Reseller Control Panel.
- Confirm that you have API authentication credentials (API username and password) for REST API access. If not, contact your Axxess account representative to obtain them.
- Confirm that you have client login credentials (client username and password) for your reseller account.
- Note the API host URL from your browser’s address
bar (for example,
https://rcp.axxess.co.za/).
Step 2: Configure the Collector in Varibill
In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select Axxess Services and Products - Version 7.1
Enter the connection parameters:
- Axxess API Authentication User: The API username for HTTP Basic Authentication
- Axxess API Authentication Password: The API password for HTTP Basic Authentication
- Axxess API Host: The base URL of the Axxess RCP
(for example,
https://rcp.axxess.co.za/) - Axxess Client User: The client username for session login
- Axxess Client Password: The client password for session login
Configure the billing parameters:
- Use Description as Product Identifier: Set to
trueto use human-readable product descriptions, orfalseto use product GUIDs - Include Client Name in Record Identifier: Set to
trueto include the client name prefix, orfalsefor product name only
- Use Description as Product Identifier: Set to
Save the collector configuration.
Step 3: Run the Collector
Run or schedule the collector according to your standard Source Collector execution process.
For detailed instructions, see: Configuring a New Cloud Source Collector
Troubleshooting
If the collector fails to connect to the Axxess API, verify that:
- The Axxess API Host URL is correct, includes
https://, and includes the trailing slash. - The Axxess API Authentication User and Axxess API Authentication Password are correct and the API credentials have not been revoked.
- The Axxess Client User and Axxess Client Password are correct and the client credentials have not been revoked or expired.
- No firewall or IP restriction rules are blocking the Varibill collector’s IP address from reaching the Axxess API host.
If the collector connects successfully but returns no data, verify that:
- Your reseller account has active clients with at least one active service subscription.
- The Axxess Reseller Control Panel is accessible and returning data correctly.
- Client services are not all suspended with suspend reason 3, which would cause them to be excluded from collection.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article