ossapi
Transcription
ossapi
Release Note 18 Extra data, when you need it New range of AUP tariffs now supporting Volume Boosters Restriction: Commercial in Confidence Quality. Flexibility. Page | 1 www.avantiplc.com Contents SECTION PAGE 1. Introduction 03 2. Summary of New Functionality 03 3. Volume Boosters 03 3.1 Overview03 3.2 Billing 04 3.3 Adding a new Volume Booster05 3.3.1 Managing Volume Boosters06 3.3.2 User Portal View07 3.3.3 Booster API08 4. Customer Facing FAQ’s 09 5. Marketing Collateral 10 Restriction: Commercial in Confidence Quality. Flexibility. Page | 2 www.avantiplc.com 1. Introduction Avanti is pleased to introduce the latest update to the Avanti OSS for SVNO Partners. This release introduces Volume Boosters for SELECT (SVNO) EAUP/AUP tariffs, in-line with EAUP volume booster functionality release for CUSTOM (GVNO) partners in 2013 (Release Note 15). If you would like further clarification on specific items, please contact the Product Department at [email protected] and copies of all release notes can be found on the Avanti Partner Portal. 2. Summary of New Functionality Features Benefits A range of SELECT (SVNO) AUP tariffs now support Volume Boosters – the ability to sell additional GB data volume to end users §§ Adds more flexibility to your products; customers may purchase additional GB data on demand, whilst have the billing certainty of EAUP §§ Increases margins and ARPU by allowing you to sell volume boosters on demand for throttled customers §§ Increase end user satisfaction by allowing throttled customers the ability to revert to headline service speed for duration of Volume Booster §§ Improve competitive positioning in market Competitive single tier pricing structure Simple pricing structure (single price per GB) across VBB and AUP equivalent still incentivises up-sell to higher packages for those end users often exceeding their monthly data allowances Availability on all 2014 AUP tariffs §§ Availability with immediate effect §§ No action required for you to gain access Partner selectable validity period up to 30 days §§ You have the flexibility to tailor the offerings you take to market API §§ You can integrate your own BSS systems for booster activation with Avanti OSS White Label User Portal §§ Flexible branding options (e.g. own band) §§ You can specify custom content such as linking to your own online payment systems or user portals §§ Provides end user information on current usage of monthly data allowance and any active boosters 3. Volume boosters 3.1 Overview This release introduces the ability to add additional usage allowance to specific devices, with this data allowance provided to the device at the headline service speed; these additional usage allowances are referred to as Volume Boosters. Volume Boosters can be added at any time over the course of the user’s calendar monthly usage cycle, regardless of how much remains on any inclusive data allowance for the end user. You will be able to define the size of the booster in integer GBs and the validity period for that booster (up to a maximum of 30 days). Applying a booster to a device will lift any throttling applied to it until either the booster data allowance has been depleted or the validity period expires. Copies of all release notes can be found on the Avanti Partner Portal. Please note that usage is always accounted against any active Volume Boosters first. i.e. if a device has monthly data allowance remaining and active Volume Boosters, then usage is accounted for against the active Volume Boosters first. Restriction: Commercial in Confidence Quality. Flexibility. Page | 3 www.avantiplc.com Volume Boosters During this month Package starts monthly with full month data allowance Package starts monthly with full month data allowance End user exhausts monthly data allowance and is throttled Partner purchases booster GB from Avanti End user service unthrottled until booster GB fully used or booster expires End user purchases booster GB from Partner *Booster GBs still active at the time of monthly data allowance reset (1st of new calendar month) carry over to the new month and are used before the new monthly data allowance. Figure 1. Volume Boosters 3.2 Billing Service packages remain billed monthly in advance for the monthly service charge. Any Volume Boosters which you have ordered via the OSS (via GUI or API) will be billed in arrears, i.e. on the 1st of the following month. During this month 1st of month - packages billed MRC in advance 1st of next month - package billed MRC In advance; package billed for booster GBs purchased in preceding month in arrears Partner purchases booster GB from Avanti End user purchases booster GB from Partner Figure 2. Billing cycle for AUP Volume Boosters Restriction: Commercial in Confidence Quality. Flexibility. Page | 4 www.avantiplc.com 3.3 Adding a new Volume Booster Volume Boosters can be added to a device via the OSS Graphical User Interface (GUI) or Application Programming Interface (API). When adding a new Volume Booster the following needs to be specified: § Device ID: VNOXXXXX § Boosters Size: The size of the booster should be specified in GB, only integer values may be entered (negative values are not accepted) § Validity period (up to 30 days): The validity period should be specified in days, the booster will expire at the same time it was added x days after it was added, regardless of how much of the booster data allowance remains Figure 5. OSS GUI Figure 4. Add New Booster Every Volume Booster added will be assigned a unique Volume Booster ID. Details of every Volume Booster you have added, both active and expired, can be viewed by clicking on the Boosters link shown in Figure 5. Restriction: Commercial in Confidence Quality. Flexibility. Page | 5 www.avantiplc.com 3.3.1 Managing Volume Boosters In order to view Volume Boosters added for a specific device, click on Devices on the OSS navigation menu, then select that device. Please note that a negative booster balance can be incurred as a result of any excess data usage by a customer. If they are using their service when their data allowance runs out, then it may be possible for them to continue using data for a short period of time before they are throttled. The negative booster balance will remain until the next time a booster is added. This will then be subtracted from the new booster amount. Clicking on the Extended AUP tab under the Device record will provide a list of all active Volume Boosters, the Volume Booster amount, the remaining Volume Booster amount, the date and time the booster was added and the expiry date/time for that specific device. A link is provided to a similar list that includes expired and active boosters, and a link is provided to add a new booster to that device. Figure 6. Update Device Information It is possible to add multiple Volume Boosters to a device at any time, which allows extra boosters to be added before current boosters expire. The new booster data allowance will be combined with any remaining booster data allowance from previous boosters. The expiry date of the new booster will be applied across all current boosters. Please be aware that this still applies even if the expiry date of a new booster is earlier than the expiry date of a current booster. Restriction: Commercial in Confidence Quality. Flexibility. Page | 6 www.avantiplc.com 3.3.2 User Portal View The User Portal display has been updated to help the end user keep better track of purchased Volume Boosters and remaining data. Figure 7. User Portal Display Customers’ data usage and remaining data allowance from their monthly inclusive usage is still displayed, however there is now a separate display showing the following: § Current Volume Booster data allowance § Expiry date and time in UTC § Remaining data allowance A note underneath the “Booster Bar” stating “You exceeded your previous booster by xxGB…” will only appear if there is a Negative Booster Allowance. However, the note in small blue print at the bottom of the display, will remain permanently in order to inform customers why their booster allowance may be less than what they have purchased; mainly due to a previous negative booster allowance. Restriction: Commercial in Confidence Quality. Flexibility. Page | 7 www.avantiplc.com 3.3.3 Booster API The Booster API allows you to integrate your own BSS to support automated 24x7 ordering and provision of Volume Boosters. The main documentation can be accessed within the OSS by visiting the REST-API documentation section: http://oss2.freenoc.lan/rest-documentation Details about the list of resources can be found here: http://oss2.freenoc.lan/rest-documentation/default/list_of_resources Details about the operations you can do on a certain resource can be found here: http://oss2.freenoc.lan/rest-documentation/default/list_of_operations The OSS API is exposed via its dedicated URL: http://oss-api.freenoc.lan To use the API, authentication is required. General API documentation may be found within Release Note 12. For those unfamiliar with APIs there are many online resources available which provide worked examples in a training format that are generally applicable to the implementation of the OSS API. These include but are not limited to: https://www.ibm.com/developerworks/webservices/library/ws-restful https://blog.apigee.com/detail/restful_api_design https://restful-api-design.readthedocs.org/en/latest Restriction: Commercial in Confidence Quality. Flexibility. Page | 8 www.avantiplc.com 4. Customer Facing FAQs Q1. When will I have to pay for my Booster? A. Service packages remain billed monthly in advance for the monthly service charge. Any Booster Packs you order will be billed in arrears. i.e. on the 1st of the following month. Q2. How many Boosters can I buy in a month? A. There is no limit on the amount of Boosters purchased at any one time, or during the calendar month. Q3. What if I don’t use all of my Booster data within the month I brought it? A. Booster GBs still active at the time of monthly data allowance reset (1st of new calendar month) carry over to the new month and are used before the new monthly data allowance. Q4. How will I know if I need a Booster? A. You’ll receive usage notification emails when you’ve reached 80% and 100% of your monthly data allowance. Q5. If I have 10% of my GB allowance left and I buy a Booster pack, what gets used first: my remaining allowance or my Booster? A. Volume Boosters are used first before the monthly usage allowance. Q6. My Booster balance sometimes shows a negative figure – why is this? A. The usage monitoring system runs in near real time, however it is possible for you to use services at your full service speed for small periods of time after your Booster expires. Any usage during this small period of time would result in a small negative value. Q6a So what happens to my Booster bill? A. Your Booster bill is unaffected as you are only charged for Boosters you’ve purchased. However, your Booster account is affected; it will show a small negative balance where you have gone over your Booster allowance. This is automatically offset when you purchase more Booster Packs. Restriction: Commercial in Confidence Quality. Flexibility. Page | 9 www.avantiplc.com 5. Marketing Collateral Avanti Marketing Services has developed collateral you can use to promote the Boosters to your customer base. Email template MPU banner advert The HTML coded email is perfect for launching the new Boosters to your customer base. This animated banner can be resized for online advertising or use on your own site. Website widget This widget sits perfectly on your front page and is a simple and effective method of guiding customers to your payment system. Email signature Whether you’re emailing new or existing customers, this email signature is an easy way for all members of your company to spread the word. How do I get all this collateral? Simply email [email protected] with your choices and your logo - the team will update the collateral with your logo and brand colours and send ready-to-use files directly to you. Restriction: Commercial in Confidence Quality. Flexibility. Page | 10 www.avantiplc.com +44 (0)20 7749 1666 [email protected] www.avantiplc.com Hughes iDirect Newtec Your hub Avanti is a carriers’ carrier, selling wholesale data telecoms to service providers which use them to create networks for enterprise, carrier, government and consumer users. Avanti’s network consists of: two high throughput satellites in orbit, called HYLAS 1 and HYLAS 2; a multiband satellite called Artemis plus a fourth satellite in construction called HYLAS 3 and an international fibre network connecting data centres in several countries. Avanti has GEO satellite network spectrum filings in the ITU Master Register for Ka-band at 33.5°W and 31.0° East and for Ka, Ku, S and L-band at 21.5° East. Avanti serves customers in Europe, Middle East and Africa. Quality. Flexibility. www.avantiplc.com