Plugin development
These guidelines should help you with creating plugin modules. These are defined to minimize manual support.
If you are new to developing with the API platform, 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 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. |
| 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 Portal | Inform the merchant that they can manage their sales units on the merchant portal. For example: "You can manage your sales unit (e.g., change name and logo), see reports of all payments, etc. on portal.vippsmobilepay.com." |
| Link to Knowledge base | Provide a link to the Vipps MobilePay Knowledge base. For example: "For typical questions and answers about payments and APIs, see the Knowledge base." |
| Info about contributing on GitHub | Add to the issues tab on your plugin's GitHub repository. |
| Link to help pages | Vipps, MobilePay Denmark, or MobilePay Finland. |
| Link to customer center for merchants | For example, "If you need help with your customer relationship with Vipps, Contact customer service. Or provide links to the specific pages: Vipps Norway, MobilePay Denmark, or MobilePay Finland." |
| Link to technical updates | "Vipps MobilePay has a technical updates 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 MobilePay calls and responses. Track and make sure to handle all errors. Present the results in a separate page of the module configuration, with the complete Vipps MobilePay 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 On-site messaging. |
| Follow design guidelines | The Vipps MobilePay branding must be according to the design guidelines. |