About the Unified API Reference Documentation

Use this guide to find different types of API content across the documentation portals.

What's in the unified API reference

The unified API reference contains comprehensive REST and SDK documentation for nearly all backend APIs and for service plugins.

When to use the unified API reference

Use the unified API reference when you need:

• Backend business logic and site operations.
• Service plugins for custom integrations.
• Cross-platform functionality that works with both REST and SDK.
• Comprehensive API documentation with both REST and SDK examples.

What's in the SDK reference

Frontend-specific and SDK-only functionality remain in the SDK reference:

• Core modules: Essential SDK functionality for authentication and client setup.
• Host modules: APIs for frontend environments like dashboard, editor, and site.
• Frontend modules: Browser-specific APIs for client-side interactions.
• Business solutions: Extensions and integrations such as dashboard plugins and dashboard pages, and specific backend APIs such as Data Items.

When to use the SDK reference

Use the SDK reference when you need:

• Frontend JavaScript APIs for browser environments.
• Core SDK setup and configuration.
• Host-specific functionality like dashboard or editor integration.
• Dashboard plugins and custom dashboard pages.
• SDK-specific implementations of select backend APIs, for example Data Items.