Skip to main content

OpenAPI 1.4.0 for Candescent DI API, Web Playground & Getting Started

Candescent Team
Candescent Team
Developer Experience Team

This release updates the Candescent DI API documentation to specification version 1.4.0. The API reference matches the latest contract. You can view the OpenAPI specification in the public GitHub repository candescent-dev/openapi.

Getting started adds a deeper error codes guide and a refreshed API categories overview. Widgets on web and mobile have updated guides, FAQ, and SDK reference. The Web Playground explains how to run the local banking shell with Docker to test widgets and aspects.

What's New​

API Reference​

The API specification is version 1.4.0. Endpoint topics are regrouped to make browsing easier. Operation pages include updated descriptions, parameters, and responses where the contract changed.

Getting Started​

For more detail, see the following updated sections:

Web Playground​

The Web Playground runs the online banking shell locally with mock data so you can load widgets, manage aspects, and try branding before production.

See Web Playground for Docker setup, run instructions, and the full walkthrough.

Widgets (Mobile)​

Mobile guides describe how to build widgets on the CDX SDK, test in the local harness, and integrate with the host app.

Widgets (Web)​

Web widget guides are updated for local development, OLB integration, and the shared SDK reference with mobile.

Get Started​

  1. Candescent DI API — Candescent DI API documentation (OpenAPI 1.4.0)
  2. API Categories Overview — Start here for capability mapping. For errors and first calls, see Error codes and Quickstart.
  3. Web Playground — Local shell for widgets and aspects
  4. Widgets overview — Web and mobile widgets. On web, continue with Getting started, Platform capabilities, and OLB integration. On mobile, continue with Getting started, Platform capabilities (local), and Host app integration. For packages, see Widgets SDK reference.

The Candescent Developer Experience Team