Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Akeeba Subscription

Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Akeeba Subscriptions User's Guide Nicholas K. Dionysopoulos Publication date September 2012 Abstract This book covers the use of the Akeeba Subscriptions component and its bundled modules and plugins for selling and managing subscriptions on your Joomla!™-powered web sites. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be found on-line at http://www.gnu.org/licenses/fdl.html. iii Table of Contents 1. Introduction and installation .............................................................................................................. 1 1. Introducing Akeeba Subscriptions .............................................................................................. 1 2. Requirements and compatibility ................................................................................................. 2 3. Installation ............................................................................................................................. 2 3.1. Installation .................................................................................................................. 2 3.2. Installation troubleshooting ............................................................................................ 2 3.3. Updating to the latest release .......................................................................................... 4 4. Uninstallation ......................................................................................................................... 5 2. Initial set-up and usage .................................................................................................................... 6 1. How subscriptions work and Quick Start ..................................................................................... 6 2. Configuration options ............................................................................................................. 10 3. Subscription Level Groups ...................................................................................................... 15 4. Subscription Levels ............................................................................................................... 15 5. Tax Rules ............................................................................................................................ 20 6. Upgrade Rules ...................................................................................................................... 21 7. Subscription Level Relations ................................................................................................... 23 8. E-mail templates ................................................................................................................... 26 9. Coupons .............................................................................................................................. 27 10. Subscriptions management .................................................................................................... 28 11. Affiliates management .......................................................................................................... 30 12. Front-end items ................................................................................................................... 31 13. Importing from other components ........................................................................................... 32 14. Custom fields ..................................................................................................................... 32 14.1. Accessing custom fields data ....................................................................................... 35 14.2. Localising (translating) custom fields' labels and options .................................................. 36 15. Integrated invoicing ............................................................................................................. 37 15.1. Invoice Templates ..................................................................................................... 37 15.2. Invoice management .................................................................................................. 38 15.3. Invoices as signed PDF files ....................................................................................... 39 16. Customising Akeeba Subscriptions ......................................................................................... 42 16.1. Customising the front-end layout ................................................................................. 42 16.2. Customising emails ................................................................................................... 42 16.3. Message variables for subscription level messages and emails ........................................... 43 3. Payment plugins ........................................................................................................................... 47 1. 2Checkout Standard Purchase Routine ...................................................................................... 47 2. AlloPass .............................................................................................................................. 49 3. Beanstream .......................................................................................................................... 51 4. BrainTree ............................................................................................................................. 52 5. CashU ................................................................................................................................. 52 6. ccAvenue ............................................................................................................................. 53 7. ClickAndBuy ........................................................................................................................ 54 8. CM-CIC P@iement ............................................................................................................... 55 9. DeltaPay (Alpha Bank, Greece) ............................................................................................... 55 10. Dwolla ............................................................................................................................... 56 11. ePay (Denmark) .................................................................................................................. 57 12. Moneris eSelect Plus ............................................................................................................ 58 13. eWay ................................................................................................................................. 59 14. GoCardless ......................................................................................................................... 60 15. Google Checkout ................................................................................................................. 61 16. IFmb (IFthen) ..................................................................................................................... 62 17. MoIP ................................................................................................................................. 63 Akeeba Subscriptions User's Guide iv 18. Moneris ............................................................................................................................. 64 19. NoChex ............................................................................................................................. 65 20. None ................................................................................................................................. 66 21. Off-line .............................................................................................................................. 66 22. PagSeguro .......................................................................................................................... 67 23. Payfast ............................................................................................................................... 67 24. Paypal ............................................................................................................................... 68 25. Paypal Payments Pro ............................................................................................................ 72 26. Paypal Payments Pro (Express Checkout) ................................................................................ 74 27. PayU ................................................................................................................................. 76 28. PostFinance.ch .................................................................................................................... 76 29. Przelewy24 ......................................................................................................................... 78 30. RBK Money ....................................................................................................................... 79 31. Robokassa .......................................................................................................................... 79 32. SCNet ............................................................................................................................... 81 33. Skrill ................................................................................................................................. 81 34. Suomen Verkkomaksut Oy .................................................................................................... 82 35. uPay .................................................................................................................................. 83 36. Verotel .............................................................................................................................. 83 37. VivaPayments ..................................................................................................................... 84 38. WorldPay ........................................................................................................................... 85 39. ZarinPal ............................................................................................................................. 86 4. Integration plugins ......................................................................................................................... 87 1. Community Builder integration ................................................................................................ 87 2. ccInvoices integration ............................................................................................................ 87 3. DOCman Integration .............................................................................................................. 88 4. JCE Integration ..................................................................................................................... 89 5. JomSocial integration ............................................................................................................. 90 6. Joomla! User Groups Integration .............................................................................................. 91 7. Joomla! User Profile Sync ...................................................................................................... 92 8. K2 Integration ...................................................................................................................... 92 9. Delete users on subscription expiration ..................................................................................... 92 10. VirtueMart 2 Integration ....................................................................................................... 93 11. AceShop Integration ............................................................................................................. 93 12. RedShop Integration ............................................................................................................. 94 13. Sample Fields ..................................................................................................................... 94 14. Automatic Country and City fill ............................................................................................. 95 15. Custom SQL scripts ............................................................................................................. 95 16. RedShop User Synchronisation .............................................................................................. 95 17. Community Builder fields sync .............................................................................................. 96 18. Kunena Integration .............................................................................................................. 97 19. Intellectual Property integration .............................................................................................. 97 20. Agora integration ................................................................................................................. 99 21. Phoca Download Integration ................................................................................................ 100 22. MailChimp integration ........................................................................................................ 100 23. Google Analytics Commerce integration ................................................................................ 101 24. AcyMailing integration ....................................................................................................... 101 25. ProjectFork integration ........................................................................................................ 101 26. EasyDiscuss integration ...................................................................................................... 102 27. TrackTime integration ......................................................................................................... 103 5. Miscellaneous plugins .................................................................................................................. 104 1. Subscription expiration control ............................................................................................... 104 2. Subscription emails .............................................................................................................. 104 3. Administrator emails ............................................................................................................ 104 Akeeba Subscriptions User's Guide v 4. Affiliate emails ................................................................................................................... 105 5. Subscription expiration notification ......................................................................................... 105 6. Content restriction ............................................................................................................... 105 7. Timed content release .......................................................................................................... 107 8. The Akeeba Subscriptions Link (aslink) plugin ......................................................................... 109 9. Agree to Terms of Service .................................................................................................... 109 10. Age verification ................................................................................................................. 110 11. IP Logger ......................................................................................................................... 110 12. ReCAPTCHA integration .................................................................................................... 111 13. PostAffilatePro integration ................................................................................................... 111 14. iDevAffiliate integration ...................................................................................................... 112 15. ccInvoices tags .................................................................................................................. 113 16. User Registration Redirection to Akeeba Subscriptions ............................................................. 115 6. Akeeba Subscriptions' modules ...................................................................................................... 116 1. List of active subscriptions .................................................................................................... 116 2. List subscription levels ......................................................................................................... 116 7. Developers' information ................................................................................................................ 117 1. The "akeebasubs" plugin events ............................................................................................. 117 1.1. onAKSubscriptionChange ........................................................................................... 117 1.2. onAKUserRefresh ..................................................................................................... 118 1.3. onSubscriptionFormRender ......................................................................................... 118 1.4. onSubscriptionFormRenderPerSubFields ........................................................................ 119 1.5. onValidate ............................................................................................................... 121 1.6. onValidatePerSubscription .......................................................................................... 121 1.7. onSubscriptionLevelFormRender .................................................................................. 121 1.8. onAKUserGetData ..................................................................................................... 122 1.9. onAKUserSaveData ................................................................................................... 122 1.10. onCancelMessage .................................................................................................... 122 1.11. onOrderMessage ...................................................................................................... 123 2. The "akpayment" plugin events .............................................................................................. 123 2.1. onAKPaymentGetIdentity ........................................................................................... 123 2.2. onAKPaymentNew .................................................................................................... 123 2.3. onAKPaymentCallback .............................................................................................. 123 1 Chapter 1. Introduction and installation 1. Introducing Akeeba Subscriptions At a glance Akeeba Subscriptions is a subscriptions management component for Joomla!™ 2.x/3.x and compatible distributions. It is built using our renowned Framework on Framework architecture which extends the standard Joomla! API, ensuring greater stability and compatibility across different Joomla! releases. It is licensed under the GNU General Public License (GPL) version 3 [http://www.gnu.org/licenses/gpl.html] or –at your option– any later version published by the Free Software Foundation. It licensing scheme means that you are free (and, in fact, more than welcome) to install it on as many sites as you want, whenever you want and use it for as long as you want, no strings attached. There are no secret per-domain licensing fees and you can use it to sell one or several millions of subscriptions without any hidden costs. We love Freedom of choice as much as you do! The killer features Its feature list is nothing short of amazing. Out of the box, Akeeba Subscriptions supports these features: • Streamlined administrator interface which can even present you an interactive sales graph and sales report as soon as you launch the component • Rich subscription levels (subscription packages) editor which allows you to choose different images for each of your subscriptions and even a different order confirmation and order cancellation text to show to your users. • The easiest subscription management interface you've seen on a component. It will even show you your users' faces, powered by Gravatar. • Users can upgrade or expand (renew) their subscriptions. Renewing a subscription will create a new subscription which becomes valid the very second their old one expires. Users do not lose any of their subscription time when renewing, unlike most other subscription systems out there. • Full support for delayed payments, e.g. when using e-checks with PayPal. • Discount coupon codes which allow you to set an absolute money value or percentage discount for all or a specific subscription level and user, have publish up/publish down dates or a usage limit (e.g. the coupon code is valid only for the first 100 people to use it) – or a combination of any and all of the above! • Automatic discounts for upgrading or renewing subscriptions based on the subscription level and days of presence in the subscription package. This allows you to easily create rules like: 30% discount if you renew up to 30 days before the end of your subscription, 15% discount if you renew within the last 30 days, no discount otherwise. • Full support for complex tax calculations based on country, state and ZIP code. It fully integrates with the European Union's VIES system so that you can charge no VAT tax for intra-EU B2B transactions. • The subscription form can work with or without Javascript. With Javascript it becomes a fully fledged, auto-vali- dating subscription form. Without Javascript it works as a standard web form, accessible to users who do not wish / cannot use Javascript on their browser. • Integration with Joomla! 1.6 and later user group mapping • Integration with third party components: K2, DOCman, JCE, VirtueMart, Tienda, JomSocial, Community Builder, ccInvoices, and much more! Check out our documentation for more information. Introduction and installation 2 • Third party integrations for Akeeba Subscriptions are available[1]: G*Sales [http://www.nobbis.net/produk- te/akeeba-g-sales-plugin.html], Zoo [https://www.zoolanders.com/extensions/item/zooaksubs], HikaShop [http:// www.hikashop.com/]. • Content restriction: a content plugin to show parts of your content only to registered subscribers, without the need of any external tool. • Payment methods: PayPal (for personal, verified and business accounts) is supported out of the box. Other payment methods are being added continuously. Over twenty of them are already implemented. Check out our documentation for more information. • Recurring subscriptions. Not all payment methods support recurring subscriptions. Please consult the documentation for further information • Send emails to subscribers upon subscription, when their subscription/payment status changes and when their sub- scription is about to expire [1] uploads/s3/ akeebasubs-guide 2 .pdf