API Capabilities
The REST API follows RESTful principles and provides:- Component management for view and layout components
- Package versioning and dependency management
- Content type definition with template support
- Content creation and management
- Asset management with CDN integration for both content and components
- Role-based access control and user management
- Multi-platform content delivery
Base URL
All API requests use this base URL:| Route Prefix | Authentication | Use Case |
|---|---|---|
/api/v1/... | x-api-key header | Client API (read-only, published content) |
/app/v1/... | Authorization: Bearer JWT | Admin API (full CRUD operations) |
Authentication
API requests require authentication. The method depends on the route: Client API (/api/v1/...) - for consuming published content:
/app/v1/...) - for content management:
Making Requests
Example Request
Example Response
Next Steps
Authentication
Set up API keys and authentication
Environments
Base URLs, versioning, and response formats
Error Handling
HTTP status codes and error responses
Core Concepts
Understand Components, Packages, and Content