Connect a machine integration with a Workspace SDK

Use the official Go, Node.js, or PHP SDK for a server-side integration bound to one tenant. After this quickstart, your service discovers the resources it may use and accesses them with a restricted API key.

Choose an SDK

Use these SDKs in a backend or worker. Never bundle the Node.js client or its API key into browser code. Use the Android SDK for native Android apps.

Prerequisites

• a Workspace installation reachable over HTTPS,
• a tenant-bound API key with only the required permissions,
• the same version number for Workspace and the SDK.

The SDKs are activated sequentially. Before installing a version, confirm that it is available in the corresponding package registry. Until then, use the documented HTTP contract or nucli.

Install the package

Choose one command and replace 7.19.0 with your Workspace version:

go get git.schukai.me/releases/nucleus-sdk-go/v7@v7.19.0
npm install @schukai/nucleus-sdk@7.19.0
composer require schukai/nucleus-sdk:7.19.0

The Go module path changes with each new Workspace major version, for example from /v7 to /v8.

Connect the client

Pass the base URL, key ID, and key secret through your application's secure runtime configuration. The client first calls public discovery and then loads authenticated resource entrypoints. Use only the returned same-origin URLs; do not construct resource paths yourself.

The SDKs cover discovery, resource entrypoints, resource metadata, lists, and server-provided actions. Business payloads remain JSON. Interactive sign-in, 2FA, and session management are outside the machine profile.

Each package contains a runnable examples/quickstart program. It validates API v1, selects a readable entrypoint advertised by the server, and requests at most one item. Its README lists the required environment variables and the language-specific command.

Verify the result

Your setup is complete when:

1. discovery reports API major v1,
2. the resource call returns only entrypoints allowed for the key and tenant,
3. your integration handles failures by HTTP status and stable errorCode.

Never log API keys, Authorization headers, complete payloads, or full error responses. Map errorCode to your own localized application message; the SDKs currently provide English technical text only.

Next step

Open the package's English README after installation. It provides language-specific examples for authentication, resources, error handling, and compatibility.