Plugin Development Kit (PDK)
The MyParcel Plugin Development Kit (PDK) is a set of tools to quickly build a MyParcel plugin for your e-commerce platform. The backend is written in PHP and the frontend is written in JavaScript.
Features
- Easy to use API
- Feature equality between all implementations
- Automated building using a configuration file
- Easily configurable
- Extensible: If the default implementation does not fit your needs, you can modify it
Terminology
The following terms are used throughout the documentation:
| Term | Description |
|---|---|
| App | Your implementation of the PDK. This is your plugin, app, module or extension that uses the PDK. |
| PDK backend | The PDK backend is the part of the PDK that is written in PHP. |
| PDK frontend | The PDK frontend is the part of the PDK that is written in JavaScript. |
| Admin | The admin is the admin panel, dashboard or backend of your app. |
| Checkout | The checkout is the checkout page of your app. |
Getting started
To get started with the PDK, you need to set up the backend and (optionally) the frontend. The backend is required for all other PDK functionality. The frontend is only required if you want to use custom checkout functionality.
Backend
The backend contains all logic to communicate with the MyParcel API. The backend is required for all other PDK functionality.
Frontend
The frontend contains the logic to render the MyParcel components that communicate with the PDK backend in your admin panel and checkout.
Examples
The PDK is used in the following plugins:
- MyParcel WooCommerce (currently in alpha)
- MyParcel PrestaShop (currently in pre-alpha)
FAQ
Why use the PDK over an SDK?
Contributing
We welcome contributions to the PDK. Please read our developer guide to get started.
License
The MyParcel PDK is open-sourced software licensed under the MIT license.
Security
If you discover a security vulnerability within the PDK, please let us know via our contact form.