Core integration

Add Cloud Phone queries, power controls, apps, files, and other capabilities to your own business system. Core is a deployed API service. The SDK only helps your code call it; installing the SDK does not start Core.

Who this is for

Teams using Cloud Phones from their own website, management system, or automation service. Administrators who want to operate devices directly can use the Web Base workbench, without installing an SDK.

What to prepare

• Obtain a deployed Core URL, management access details, and a test Cloud Phone from the platform team.
• Confirm that your business backend can reach Core. Define which devices and operations each user may access, and for how long.
• Choose direct HTTP API calls or the optional Node.js SDK. Obtain the SDK installation package from your delivery team.

Ordinary users keep using your business login: their browser calls your own backend, which calls Core. Your backend keeps the management keys and Core access credentials; ordinary users do not receive them.

Integration steps

1. Choose capabilities. Check the capability catalog for your business needs and usage limits.
2. Find the test Cloud Phone. Confirm its identity and access scope, then submit an operation such as power-on.
3. Track the result. Use the returned Task ID to check progress and results, then confirm the effect on the device. An accepted Task is not a completed operation. If the result is unclear, check the original Task before repeating it.
4. Connect business users. Your backend checks each user's current resources, permissions, and validity period on every request. Logging out or disabling an account must also revoke its Core access.
5. Validate before opening access. Test unauthorized access, expiry, and failures. If streaming is required, complete the separate Player integration and real-device acceptance.

Integration examples

Your own management backend or automation service

Your management backend / automation service → HTTP API or Node.js SDK → Core

For example, list Cloud Cards in your own backend or check Task results on a schedule. Your code calls Core from a trusted server, using HTTP requests directly or the SDK. This read-only snippet lists Cloud Cards; it is not an endpoint to expose directly to ordinary users.

Developer example: Query Cloud Cards with the SDK

import { createServerClient } from '@cloud-mobile-core/http-client/server';
import { coreOrigin, credentials } from './server-config.js';

const core = createServerClient({
  baseUrl: coreOrigin,
  serviceKey: credentials.key,
  serviceSecret: credentials.secret,
});
try {
  const page = await core.boxes.list({ page: 1, page_size: 50 });
  console.log(page.data);
} finally {
  await core.close();
}

The SDK requires Node.js ≥22.14.0. Obtain the installation package from your delivery team. Your backend loads secure configuration through server-config.js; keep it out of browser code. This example is a one-off script. A long-running service can reuse the client and close it when the service shuts down.

An existing website for your customers

Customer browser (existing login) → Your website backend (access checks) → Core

For example, customers sign in to your website and only view or operate devices they are allowed to use. Your backend checks the current user, device scope, allowed operations, and validity period before forwarding each request. The SDK's session proxy can help with these calls; you still supply your own login and access rules. Management keys and Core credentials stay in your backend, which also revokes access on sign-out. Do not expose the management query above directly to customers or let the browser declare its own permissions.

Both approaches use Core's APIs. Queries read synchronized data; Core sends device operations to a registered Machine Room for execution. Your business system does not need to connect directly to Cloud Phones.

Responsibilities

Platform team	Your team
Provide the Core URL, access details, test devices, and API reference	Manage user login and access, protect keys, and connect your backend
Maintain Core and device execution services; provide Task results	Handle progress and failures; verify business flows and device effects

Next technical resources

Query Cloud Phones · Check before an operation · Submit a power-on Task · Query Task results

Download the English technical reference · Download the English OpenAPI reading view · Original API Contract