Skip to main content

Explore the APIs, Extension Template Catalog & TypeScript SDK

This release adds an Explore the APIs section with Overview, API Playground, and Postman Collections guides — helping developers compare testing options, send live Stage requests from the Try It panel, and get guidance for Postman collections available in the public OpenAPI repository below. New Extension Template Catalog guides for Web and Mobile widgets document catalog-driven scaffolding with interactive CLI pickers, list commands, and harness preview workflows, alongside updated Getting Started paths for offline and catalog-based generation. TypeScript SDK documentation now displays the current package version (1.1.0) and clarifies that SDK and OpenAPI specification versions are tracked independently.

You can view the OpenAPI specification in the public GitHub repository candescent-dev/openapi.

What's New​

Explore the APIs Guide​

  • Overview — Introduces the Explore the APIs section and compares API Playground and Postman Collections so developers can choose the right path for quick in-browser checks or full multi-step workflows.
  • API Playground — Documents the in-browser Try It panel on API Reference pages for live Stage requests using Developer Console sign-in or a bearer token.
  • Postman Collections — Documents how external integrators import collections and environments from the public Candescent OpenAPI repository, configure Sandbox, Stage, or Production environments, and run API workflows.

Extension Template Catalog​

  • Web widgets — Documents remote, versioned Candescent starters for web widgets, including nx run list-web-widget-templates and nx run generate-web-widget with category and template pickers.
  • Mobile widgets and features — Documents nx run generate-mobile-extensions, generate-mobile-widget, and generate-mobile-feature for DI-backed React Native scaffolds wired to @cdx-extensions/di-sdk (PlatformSDK).
  • Catalog vs offline starter — Updated Getting Started guides for web and mobile to compare blank offline scaffolds with catalog-driven generation paths.

TypeScript SDK Documentation​

  • Version badge — TypeScript SDK Overview and Installation pages display the current package version (1.1.0).
  • Versioning clarity — Removed pinned OpenAPI spec version references across Server-side SDK guides so SDK and API specification versions are documented as independently tracked.
  • SDK Reference — Simplified versioning guidance and clarified CandescentClient credential requirements in the constructor table.

Get Started​

  1. Explore the APIs — Discover the Overview, API Playground, and Postman Collections guides.
  2. Web Extension Template Catalog — Browse and generate web widgets from the remote template catalog.
  3. Mobile Extension Template Catalog — Browse and generate mobile widgets and features from the remote template catalog.
  4. Web Widgets Getting Started — Choose between offline starter and catalog template scaffolding.
  5. Mobile Widgets Getting Started — Choose between offline starter and catalog template scaffolding.
  6. Server-side SDK Overview — Choose the right client and find the npm package and examples repo.
  7. TypeScript SDK Overview — CandescentClient, automatic OAuth, typed models, and package version 1.1.0.
  8. TypeScript SDK Installation — Install @cdx-forge/di-typescript-sdk and set credentials.

The Candescent Developer Experience Team