Blocklet Service is a foundational layer that provides a suite of ready-to-use, reusable services for blocklets. It is designed to run within a Blocklet Server environment and acts as a central hub for common functionalities that applications often require. By offering these services out-of-the-box, it accelerates development, ensures consistency, and reduces the redundant work of building essential features from scratch.
This documentation is structured to guide two primary types of users: administrators who manage blocklets through a web interface, and developers who build applications on the platform. The following diagram illustrates the relationship between these users, the Blocklet Service, and the overall environment:
Core Functionalities
Blocklet Service provides a wide range of services that can be categorized as follows:
Authentication Service
Manages user identity, login, and session management using Decentralized Identifiers (DID). It also supports third-party OAuth providers.
Notification Service
Enables sending multi-channel notifications to users, including wallet messages, emails, and push notifications.
Image Service
Provides on-the-fly image processing, such as resizing, cropping, and format conversion.
MCP Service
Allows blocklets to interact with the Model Context Protocol (MCP) server for integrating AI-powered features.
EventBus Service
Facilitates communication between different blocklets and the core system through a publish-subscribe model.
KYC Service
Integrates Know Your Customer (KYC) processes for user identity verification.
Discovery & SEO Services
Enhances discoverability through services like Open Graph, oEmbed, and automatic sitemap generation.
OAuth Service
Integrates third-party authentication providers like Google and GitHub for federated login.
How This Documentation is Organized
To cater to different needs, this documentation is divided into two main parts, ensuring that both administrators and developers can find the information relevant to their tasks efficiently.
For Administrators: User Guide
The User Guide is intended for non-technical users and system administrators. It provides clear, step-by-step instructions for configuring and managing the various features of Blocklet Service through the web dashboard. This guide focuses on practical application management, monitoring, and customization without requiring any knowledge of coding.
For Developers: Developer Guide
The Developer Guide is a comprehensive resource for software developers. It contains detailed technical information, API references, code snippets, and integration workflows necessary to programmatically utilize the reusable services provided by Blocklet Service in custom applications. This guide is designed to help developers build, extend, and integrate their blocklets with the platform's core functionalities.