Skip to content
All guides

Settings and connections / External connections

Connect external apps and devices to Nexia APIs

Register user and unattended-device connections, assign access, inspect API contracts and review request and response history.

Last reviewed October 28, 2026

Before you start

Open Settings → Company administration → Data and integrations → Developer API. The beta menu badge identifies this as a beta feature. If the menu is missing, ask your administrator to check Developer API management permission and feature availability.

Developer API lets external programs call Nexia platform and App business functions. To configure Nexia to call another service, use the external connections guide. iOS, Android and .NET clients can use ordinary HTTP; a dedicated SDK is not required.

Access to the management page does not grant every business permission. The connection's allowed operations and the caller's current business, organization and record permissions all apply.

Check the environment and operations

  1. Check the Development sandbox or Workspace label and API address at the top. Credentials belong to the environment that issued them.
  2. Under API reference, choose the platform or an App. Operations are grouped by business resource and show a function name and colored HTTP method. Open an operation to inspect its parameters, request, response and required permission.
  3. Use Download OpenAPI to share the specification with your integration developer. Available APIs are included automatically at registration; actual access remains limited by the account’s roles and scopes.

The catalog and specifications come from existing platform and App functions; you do not register each function again. An App under development can be used before release submission once its functions are reflected in the selected sandbox runtime. Source edits alone may not appear until that runtime is updated.

An incomplete-specification notice means some input or response information is missing. Dynamic validation may not be fully documented, so inspect actual errors too.

Connect an app with user login

  1. Under API credentials → Register client, enter a name and select the user-login option for iOS, Android or desktop.
  2. Enter the return address supplied by your integration developer, register the connection.
  3. Give the developer the Client ID, authorization endpoint and token endpoint.
  4. Sign in and consent from the external app. Users of the tenant's SSO follow their existing SSO login flow.

The integration must implement Authorization Code with PKCE. Calls use the signed-in user's current permissions, not the administrator's authority.

Connect an unattended device or server

Use a separate Device/service account for a panel PC or server without interactive login. Registering an asset alone does not create API credentials.

  1. Under device/service account management, enter a name and select a Role and Access scope. Select the legal entity or operating unit when required, then register the account and role.

  2. Roles are managed in Settings → Roles. Use Create role or role management below the role input. Only roles composed of standard business permissions for available APIs can be selected. A role containing any company-wide permission can only be assigned company-wide; roles composed of legal entity or operating unit permissions can be limited to those scopes. Operations requiring user login cannot be used by a device account.

    With role management permission, use Check role compatibility to select a source role and access scope, then review retained and excluded permissions and limited APIs. With role creation permission, create a new role from the reviewed permissions. The source role is unchanged. Additional permissions not declared by an App cannot be checked in advance; actual calls still enforce authorization.

  3. Under API credentials → Register client, choose the device/server option and select the account you created.

  4. Store the displayed client ID and secret in a secure credential store before acknowledging that you saved them. The secret cannot be displayed again after closing this view.

  5. The integration uses client credentials at the token endpoint to obtain an access token. Keep the secret out of public app code and openly readable configuration.

The device acts only within its assigned roles and scopes. It does not inherit its creator's permissions or replace a person's signature or assigned human tasks.

Make a request and inspect the result

  1. Open an operation and enter the connection's access token under Try a request. Use the token issued after authentication, not the client ID. For documented inputs, follow the description, required status, format and example. Examples are not sent automatically.
  2. Send the request. Changes require confirmation and modify actual data, including in a sandbox.
  3. Inspect the response and request ID. If no response arrives, the result is uncertain: inspect history before attempting another write.

The token is not persistently stored by this screen. An idempotency key prevents duplicate execution only when the selected API supports it.

Where Find in a list is available, look up path identifiers with the same token and choose the documented identifier field and target. Internal and public identifiers may differ. The picker shows up to 50 records from the current response; use the list API to specify other pages or query conditions. The administrator's browser-session authority is not used for these requests.

Documented query parameters and JSON bodies have individual fields; use Switch to advanced JSON editing for complex input. When documentation is missing, confirm the required keys, formats and lookup route with the API provider. APIs without external execution or permission bindings, or with non-JSON-only request bodies, show an explanation instead of a request form.

Diagnose calls with history

Open the API call history table to inspect calls from the last seven days. Search by request ID, sort columns or change the page size. Select a row to open its request, response, status code, duration and request ID in the Inspector. For missing input, read the field-level validation errors and correct the request.

  • 401: check token expiration, revoked connections, disabled accounts and whether credentials belong to this environment.
  • 403 or 404: check allowed operations, current business permissions, organization scope and selected App runtime. Unauthorized operations may be hidden from discovery and dispatch.
  • 422: check required values and input formats.
  • 429: reduce request frequency and follow any retry timing in the response.

Credentials are masked. JSON bodies are stored up to 64 KiB. Binary, streamed, oversized or invalid JSON bodies have an omission reason instead. An absent body in history does not mean the request was never executed.

Stop access

To stop one connection, revoke it under registered connections and confirm. Its tokens become invalid. To stop a device account, disable it under device/service account management.

Sandbox expiration or ending user testing also ends access based on that temporary authority. For implementation details and contracts, see the Developer API documentation.

More guides for this capability

Nexia Cloud OS

Connect external apps and devices to Nexia APIs

Connect mobile apps, desktop clients and panel PCs, then check actual API results.