Plugin development
Follow these guidelines while creating plugin modules. These are defined to minimize manual support.
If you are new to developing with the API, see the Getting started guide.
Plugin Checklist
Use this as a guideline to make sure documentation and the required features are provided. These requirements come in addition to those described in the partner's guide: Finishing the integration and going live.
Documentation
Your plugin module must include all the following information:
| Required content | Comment |
|---|---|
| List of features | A list of available features and information about how to configure, enable, and disable them. |
| Install plugin | Description of how to install the module. |
| Prerequisites | A list of prerequisites for using the module. |
| Configuration | Information about all the configurable features. |
| Get API keys | Detailed 1-2-3-type list with reference how to get API keys. |
| Info about on-site-messaging | Specify how to configure in module or add a link to Vipps on-site-messaging. |
| Notification on available updates | If it's not default by platform, show a notification banner when an update is available for the module. |
| API Dashboard | Inform that merchants can use the Vipps API Dashboard to follow up on errors. |
| Changelog | Detailed release notes for new releases. Do not add cryptic comments about updates, but describe what is new. |
| FAQ | A list of frequently asked questions and information about other typical issues related to the platform and module. |
Also include the following support information:
| Required content | Comment |
|---|---|
| Support | Provide information about how to get help with the plugin or module. Link to the plugin's support system. Do not link to Vipps contact page. |
| Link to Vipps Portal | Inform the merchant that they can manage their sales units on the Vipps portal. For example: "You can manage your sales unit (e.g., change name and logo), see reports of all payments, etc. on portal.vipps.no." |
| Link to Vipps FAQ | Provide a link to the Vipps FAQs. For example: "For typical questions and answers about Vipps payments and APIs, see the Vipps FAQs." |
| Info about contributing on GitHub | Add to the issues tab on the GitHub repo. |
| Link to Vipps help pages | "The Vipps help page" |
| Link to Vipps customer center for merchants | "If you need help with your customer relationship with Vipps, Contact Vipps customer service." |
| Link to newsletters | "Vipps has a technical newsletter with news about APIs, etc. We recommend subscribing to it." |
Development and required features
Include the following details and routines as part of the module.
| Required content | Comment |
|---|---|
| Error Logging | Include the option to activate debugging mode with enhanced logging and tracking of all Vipps calls and responses. Track both error codes and error messages. Present the results in a separate page of the module configuration, with the complete Vipps error message displayed. |
| Error Handling | Ensure that users, both administrators and customers, receive an unambiguous notification when anything goes wrong. For POS integration, present the information to both the cashier and the customers. |
| Follow up on GitHub security/Dependabot alerts | Ensure that security alerts are added to pull requests and that there is a monthly routine in place for handling these. |
| Order Management | Add receipts to orders using the Order management API. |
| On-site-messaging configuration | Add a configurable On-site-messaging feature to ease the Vipps on-site-messaging. |