Pulse tenant

Before integrating operational data with Pulse, a Pulse tenant must be provisioned and configured for the required model.

A Pulse tenant provides the API endpoint, authentication context, and model-specific services used by the integration.

This page describes the setup sequence at a high level. Use the OpenAPI specification for the exact provisioning and API contracts rather than reproducing endpoint definitions here.

Before you begin

Confirm:

• which Pulse domain model the tenant will use;
• which organization or subscription the tenant belongs to;
• who requires access to the tenant;
• which source systems will provide data.

The selected domain model determines which data structures and integration services are available in the tenant.

Provision the Pulse tenant

A Pulse tenant belongs to a subscription and is configured for a specific Pulse model.

Tenant provisioning is performed through the Pulse tenant-management tool. When the tenant is created, the required model, such as Food & Beverage or Metal & Machining, is selected.

Use the tool's OpenAPI specification to determine:

• the available provisioning operations;
• required request parameters;
• supported models;
• request and response schemas;
• validation and error responses.

Do not implement the underlying provisioning sequence manually unless explicitly required by the integration architecture.

Obtain tenant details

After the tenant has been provisioned, obtain the API base URL assigned to it.

Generate an API authentication token from the tenant settings and store it securely. The token is used for authenticated requests to the Pulse API.

See Authentication for authentication and token-handling guidance.

Verify API access

Before mapping or submitting production data, verify that the tenant can be reached using its assigned base URL and authentication token.

Send a small authenticated request using the API for the configured model before proceeding with the full integration.

Refer to the domain model-specific integration documentation for the appropriate request and validation guidance.

Choose the domain model-specific integration

Once the tenant is available and API access has been verified, continue with the integration guide for the configured model.

The domain model documentation defines:

• the available business resources;
• resource relationships;
• required business identifiers;
• recommended submission order;
• model-specific integration options;
• validation and integration examples.

Available domain models include:

• Food & Beverage
• Metal & Machining

Choose an integration option

The available integration options depend on the selected model.

These may include:

• REST API for direct programmatic integration over HTTP;
• .NET client for automated integrations from .NET applications and services;
• Excel import for file-based data preparation and import.

All supported options use the data model defined by the selected Pulse model.

Refer to the model documentation for the options currently available for that model.

Prepare the source data

Before sending production data, identify how the source-system records map to the resources defined by the selected Pulse model.

Typically, the integration should establish stable reference and master data before submitting records that depend on them.

The exact resources, relationships, and submission order are model-specific and are documented in the corresponding integration guide.

Validate the tenant

Before moving the integration into regular production use, confirm that:

• the correct Pulse domain model is configured;
• the assigned API base URL is reachable;
• authenticated API requests succeed;
• required source-system data can be mapped to the selected model;
• referenced records can be created and retrieved successfully;
• validation and error responses can be handled by the integration.

See Validation and Troubleshooting for general integration guidance.

Next steps

1. Configure authentication.
2. Open the OpenAPI reference for the Pulse tenant.
3. Choose the configured domain model.
4. Follow the model-specific integration guide.
5. Verify the integration with a small test request before submitting production data.