SDK and API coverage

Use this page when you are choosing how to integrate Switera into an application or backend service. The matrix reflects the packages that exist in the current repository and the launch API families exposed by the Switera API.

Integration paths​

SDK package matrix​

Product API coverage​

Vault key identifiers and rotation​

Keep Vault operations on your trusted backend. Key creation returns both an id (UUID) and a name. Get, rotate, and delete take the UUID; encryption, signing, and tokenization take the name. Do not pass the name into a key management URL.

const key = await client.vault.createKey({ name: 'customer-documents', purpose: 'encryption' });
await client.vault.getKey(key.id);
const encrypted = await client.vault.encrypt(key.name, 'private text');
await client.vault.rotateKey(key.id);
const decrypted = await client.vault.decrypt(key.name, encrypted.ciphertext);
const text = Buffer.from(decrypted.plaintext, 'base64').toString('utf8');

The SDK encodes encryption/signing input as base64 for the REST API. Tokenization sends value and optional ttl_sec, not plaintext or ttl_seconds. Keep the complete version-prefixed ciphertext and any authenticated context; stripping the prefix or changing context prevents correct decryption.

Rotation retains earlier encrypted key material so existing ciphertext, tokens, and signatures remain usable. Disabling a key prevents use; deleting it is destructive. A rotation cannot restore key material already lost before history was retained. Java and .NET remain scaffolds, not verified production integrations.

Generated API reference​

The docs repository includes a generated Markdown reference under docs/api-docs, refreshed from the backend repository's src/api/docs/swagger.json. It describes annotated API contracts; a generated entry does not establish live acceptance of that operation.

The public docs intentionally keep the machine-generated reference separate from the main navigation until operation IDs, model names, and examples are fully curated for external readers. Use the task pages first, then use the generated reference for exact route names and request/response shapes.

SDK smoke checks​

The repository includes a package smoke runner for launch readiness:

scripts/smoke-sdks.sh

The runner installs and builds available JavaScript packages, imports their public entrypoints where safe, runs Go SDK tests, runs Python SDK tests in an isolated virtual environment, and checks other language packages when their toolchains are installed. Jenkins runs it with Node, Go, Python, Ruby, and PHP before image builds. Its separate quality gate also runs API/starter race tests against a disposable database, the Node Vault SDK against real API handlers, frontend checks, and a reachable-vulnerability scan.

Refresh command​

From the docs repository root, point the refresh script at the backend's generated OpenAPI file:

scripts/refresh-api-docs.sh ../switera-backend/src/api/docs/swagger.json

The script only reads the supplied file and rebuilds docs/api-docs. It does not modify another repository. Regenerate and commit backend Swagger annotations in the backend repository before refreshing this reference.

Current launch gaps​

• Complete real passkey registration/login/removal and the authenticated inventory retest; resolve the browser Realtime origin failure. Complete MFA login-attempt binding checks and mailbox-backed Auth/tenant-isolation journeys before treating package availability as launch readiness.
• Billing, Storage, Managed Data, Realtime publish, and API-key management need first-class typed resources in the backend SDKs. Node now covers Vault, while Search, Feature Flags, and Realtime need broader backend language parity.
• Java, C#, Flutter, Android, Swift, and React Native packages have smoke coverage only when the matching local or CI toolchain is available.
• Generated operation IDs still need curation before the machine-generated API reference should become the main public reference.