Skip to main content

12 posts tagged with "API"

API reference, new endpoints, or API behavior changes

View All Tags

Developer Console - AI Assistant, Environment Switcher, Managing Apps and API Credentials & OpenAPI 1.11.0

Candescent Team
Candescent Team
Developer Experience Team

This release adds two new Developer Console guides — AI Assistant and Environment Switcher — and significantly updates Managing Applications and API Credentials with expanded apps and key management workflows, refreshed UI graphics, and end-to-end key lifecycle documentation. This release also syncs the Candescent DI API reference to specification version 1.11.0. Customer Campaigns — Audience and Promotions Suite subcategories document SFTP file registration, upload job monitoring, and renamed user list endpoints. Documents and Preferences — Electronic Statements and the Error Codes Reference are updated to align with contract messages.

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

Electronic Statements, Jobs and Error Codes & OpenAPI 1.10.0

Candescent Team
Candescent Team
Developer Experience Team

This release syncs the Candescent DI API reference to specification version 1.10.0. The Electronic Statements subcategory is updated with renamed endpoints, refreshed request and response schemas, and expanded category documentation for account and user-level preferences. Jobs reference pages (used when uploading participants to Customer Campaigns — Experience Groups) document paginated import-job monitoring, job status values, and log entry-level error retrieval. The Error Codes Reference and Digital Banking APIs MCP guides are aligned with the updated contracts.

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

Submissions Guide Updates, Features Guide, AI Documentation Assistant & OpenAPI 1.9.0

Candescent Team
Candescent Team
Developer Experience Team

This release updates Submissions documentation in the Developer Console to align with the automatic GitHub PR creation workflow and document automatic metadata population when a Pull Request (PR) is created in the private repository. Feature documentation is separated from the Widgets guide into a dedicated Features guide. The documentation site also introduces the AI Documentation Assistant, available from the Ask button in the navigation bar. This release also syncs the Candescent DI API reference to specification version 1.9.0 - including updates to the Customer Campaigns — Experience Groups subcategory.

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

Explore the APIs, Extension Template Catalog & TypeScript SDK

Candescent Team
Candescent Team
Developer Experience Team

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.

API Playground, MCP Server Guide & OpenAPI 1.8.0

Candescent Team
Candescent Team
Developer Experience Team

This release introduces an interactive API Playground with Try It support, enabling live Stage requests directly from the documentation using Developer Console authentication or a Stage API key. It also adds new MCP Server guides covering Overview, Installation, Quick Start, and Digital Banking APIs, including Stage and Sandbox connectivity, OAuth setup, and supported Core Banking and User API MCP tools. The Candescent DI API reference has also been updated for Retrieve Institution User (V2).

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

Forge CLI alignment, extension guides & OpenAPI 1.7.0

Candescent Team
Candescent Team
Developer Experience Team

This release refreshes the Forge CLI documentation for the release CLI: simplified auth, forge doctor, widget/aspect API contract commands, updated template counts and preset names, and removal of deprecated OIDC CLI workflows. We added the Create Your Own section, which covers FI-hosted applications launched in-frame or in a separate browser window, with Candescent managing the widget container, header, and SSO handoff. Additionally, the Extension Points section now describes how the platform defines stable extension point IDs, how extensions register through manifests, and how the extensibility framework resolves and loads them at runtime across web and mobile. This release also updated MX category taxonomy by refining categories and subcategories for consistency and clearer classification.

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

Server-side SDK Guides — TypeScript SDK | OpenAPI 1.6.1 - OAuth Updates

Candescent Team
Candescent Team
Developer Experience Team

This release adds a new Server-side SDKs section to the Guides sidebar, with full documentation for the @cdx-forge/di-typescript-sdk Node.js client. The guides cover installation, authentication, typed API usage, runnable examples, framework integration patterns, and troubleshooting — so backend developers can integrate Candescent DI APIs without hand-rolling HTTP clients and OAuth flows. This release also syncs the Candescent DI API reference to specification version 1.6.1 - including updates to the OAuth verification.

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

OpenAPI 1.6.0 — Unified Base URLs & API Paths | Endpoints Added to MCP Server

Candescent Team
Candescent Team
Developer Experience Team

This release syncs the Candescent DI API reference to specification version 1.6.0. Base URLs now use dedicated Sandbox, Stage, and Production hosts, and endpoint paths are aligned to a consistent /v1/... (and /v3/... where applicable) structure instead of legacy service-prefixed routes. The introduction page, authentication examples, and generated operation topics are updated across all API categories.

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

Developer Console Guides, OpenAPI 1.5.0 with Payments APIs

Candescent Team
Candescent Team
Developer Experience Team

This release refreshes Developer Console documentation for Submissions, the Marketplace Product Catalog, and Managing Applications and API Credentials — including guidance on deleting an application and updated graphics aligned to the current UI. The Candescent DI API reference is synced to specification version 1.5.0, including a new Payments area for ACH and wire operations. The error codes guide includes more details.

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

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.