D4.5 Guidelines and Instructions for PLUGGY Apps
D4.5 gives guidelines and instructions for future developers of the PLUGGY pluggable applications and plugins. It condenses not only the development experience gained by the PLUGGY consortium, but also that of the external developers who participated in the App Challenge during the project and greatly contributed to the improvement of the PLUGGY Application Programming Interface (API).
The PLUGGY architecture was devised to be modular and to provide an API for the future development of applications, which will provide novel ways to experience and curate cultural heritage content. The PLUGGY consortium provides developers with a set of resources that allow the unassisted development of such applications, including:
The Guidelines and Instructions for PLUGGY apps (this document).
A set of source code examples at https://isensegitlab.iccs.gr/pluggy_public/pluggy-examples
The online API documentation at https://pluggy.eu/api/doc/
This document provides an overview of the PLUGGY Architecture and Data Model.
Practical help comes in the form of code snippets which illustrate basic functionality of the API –such as Search or Asset3 Creation–, and more advanced example use cases which show how to create different plugins and applications. It also provides instructions on how to become a PLUGGY developer and how to register applications to the PLUGGY platform.
These resources should be sufficient to start unassisted development of pluggable applications. However, PLUGGY is evolving and so will its API. The online documentation may be more updated that this document, and developers who seek updated support can reach the consortium at firstname.lastname@example.org.