Core Concepts
Understanding Plandalf's core concepts will help you make the most of the platform. Here's an overview of the key concepts and how they work together.
Architecture Overview
Plandalf is built on a modern, component-based architecture:
Service API
| Component | Description | Usage |
|---|
| Base URL | https://api.plandalf.com/v1/ | Primary endpoint for all API interactions |
| Authentication | API Keys | Use backend API keys to authenticate requests |
| Response Format | JSON | All API responses are in JSON format |
Data API
| Component | Description | Usage |
|---|
| Base URL | https://data.plandalf.com/client | Primary endpoint for all front-end interactions |
| Authentication | Agent JWT | Use Authorized JWT to authenticate requests |
| Response Format | JSON | All API responses are in JSON format |
SDK
| Component | Description | Usage |
|---|
| JS Client SDK | <script src="https://js.plandalf.com/v1.js"></script> | JS Client SDK |
| JS App SDK | npm install @plandalf/plandalf-js | JS App SDK |
| React SDK | npm install @plandalf/react-plandalf-js | React SDK |
Billing Models
| Model | Description | Usage |
|---|
| Package | Product tier template | Define pricing tiers (e.g., Basic, Pro, Enterprise) with shared feature sets |
| Plan | Specific package variant | Create variations of a package (e.g., Monthly Pro, Annual Pro) with different terms |
| Charge | Individual billable item | Track usage-based or one-time charges |
| Feature | Specific product capability | Control access to functionality |
| Inclusion | Bundled items within a plan | Define what's included in each tier |
| Metrics | Usage measurements | Track and bill based on consumption |
Analytics Models
| Model | Description | Usage |
|---|
| Flow | Complete user journey | Track end-to-end interaction paths |
| Scenario | Flow variant | Monitor particular user scenarios |
| Activity | Group of related actions | Analyze user engagement patterns |
| Action | Individual user interaction | Track specific user behaviors |
