Skip to main content

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.

What's New​

Server-side SDKs — Overview​

  • Server-side SDK overview: Introduces Candescent's family of typed backend clients for DI APIs — who should use them, the npm package (@cdx-forge/di-typescript-sdk), and the cdx-typescript-sdk examples repository.

TypeScript SDK Guides​

  • TypeScript SDK overview: CandescentClient entry point, automatic OAuth, typed models generated from the OpenAPI 1.6.0 spec, PageIterator for paginated lists, typed errors, built-in retries, and standalone operation imports via @cdx-forge/di-typescript-sdk/operations.
  • Installation — Install the package (Node.js 20+, ESM only), configure CANDESCENT_* credentials, and verify the SDK loads.
  • Quick Start — Create a client, authenticate with OAuth 2.0 client credentials, list accounts, and call business banking and standalone operations.
  • SDK Reference — Full client API, service-area properties, configuration options, and package exports.
  • Examples — Clone cdx-typescript-sdk, configure Stage credentials, and run scripts for every API area.
  • Framework Integration — Reuse a single CandescentClient in Express/Fastify servers and serverless functions; graceful shutdown and token cleanup patterns.
  • Troubleshooting — Common setup, authentication, and runtime issues with fixes.

API Reference​

  • The API specification is version 1.6.1.
  • Authentication reference documentation for OAuth V1 and OAuth V2 is updated and verified against the OpenAPI specification and live API behavior. Request/response examples, endpoint descriptions, and generated operation pages now reflect the current authentication flows.

Get Started​

  1. Server-side SDK Overview — Choose the right client and find the npm package and examples repo.
  2. Installation — Install @cdx-forge/di-typescript-sdk and set credentials.
  3. Quick Start — Make your first typed API call from Node.js.
  4. Examples — Run runnable scripts against Stage.
  5. Candescent DI API — Review updated documentation (OpenAPI 1.6.1).
  6. Authentication — View OAuth token APIs and authorization flows.

The Candescent Developer Experience Team