Skip to content
  • There are no suggestions because the search field is empty.

Equipment CRM and Service Management CD - API Authentication Changes

In This Article

Introduction

On June 30th, 2026, Caterpillar will be updating the authentication method for all of their API services from PingFederate to Microsoft Entra. This migration will require Caterpillar to issue new credentials to all organizations who integrate with API services such as Cat Configurator, Cat Interact, and VisionLink.

If your organization’s Texada system integrates with one or more of Caterpillar’s API services, you may need to take action as a result of this change. Keep reading to learn more.

What You Need To Do

In order to continue using Caterpillar’s API services with your Texada system after June 2026, your organization will need to take the following steps:

1. Contact Caterpillar for new API credentials

Most sets of API credentials consist of three values:

  • Scope: The specific data or actions your application is allowed to access.
  • Client ID: The unique ID that identifies your application.
  • Client Secret: A private key your application uses to prove its identity.

All three of these values are provided by Caterpillar. To receive new, post-migration API credentials, reach out to your Caterpillar representative. 

Each API service offered by Caterpillar requires its own set of credentials. For example, if you use both VisionLink and Prime Product+, you will need a separate Scope, Client ID, and Client Secret for each of these services.

For this reason, Texada recommends compiling a list of services your organization uses before reaching out to Caterpillar.

2. Update credentials in CloudLink Console

In your Texada system, credentials for Caterpillar’s API services are stored using configuration keys.

Once Caterpillar has provided you with new credentials for the API services your organization uses, you will need to update the corresponding configuration keys in CloudLink Console. See “Manage Configuration Keys” for more information.

Refer to the “Affected APIs” section below for the specific configuration keys to be updated.

For APIs that include an API Scope configuration key, entering a value for that key will trigger the system to start using the new Entra authentication method for that API. In other words:

  • If API Scope is blank, the old PingFederate authentication method will be used.
  • If API Scope has a value, the new Microsoft Entra authentication method will be used.

As such, setting the value of this key is an effective way to test the new configuration in advance of the switchover date. Texada recommends experimenting with the new configuration as soon as you receive new API credentials from Caterpillar. This will provide you with sufficient time to troubleshoot prior to the June 30th, 2026 cutoff date.

Affected APIs

In this section, you will find a list of Caterpillar – Texada APIs affected by this migration, including the relevant configuration keys for each API.

Aftermarket Prioritized Service Events (PSE) Unite

Aftermarket Prioritized Service Events (PSE) Unite is Caterpillar’s service intelligence platform that aggregates machine health data and applies prioritization logic to identify and rank actionable service opportunities. For equipment dealers, it provides a structured, data-driven queue of recommended service events, enabling proactive customer outreach, improved service planning, and integration with dealer service management systems through APIs.

For information on how PSEs are used in Equipment CRM, see “SalesLink PSE Integration”.

CAT PSE API Scope

  • Key: api.cat.pse.scope
  • Visibility: Public
  • Description: Defines the scope parameter used during authentication with Microsoft Entra to retrieve an access token for the Caterpillar Prioritized Service Events (PSE) API. Typically, this value should be set to {client_id}/.default, where client_id matches the CAT PSE API Client ID used for authentication. This convention may change in the future based on Microsoft or Caterpillar requirements. If this key is populated with a value, the system will use Microsoft Entra authentication in place of the previous Ping Federate authentication method.

CAT PSE API Client ID

  • Key: api.cat.pse.clientid
  • Visibility: Public
  • Description: This key specifies the client ID used to authenticate with CAT PSE APIs. This value is required when using the Microsoft Entra authentication provider.

CAT PSE API Client Secret

  • Key: api.cat.pse.secret
  • Visibility: Public
  • Description: This key specifies the client secret used to authenticate with CAT PSE APIs. This value must correspond to the client ID and is required when using the Microsoft Entra authentication provider.

Prime Product+ Lead API

Caterpillar Prime Product+ is Caterpillar’s centralized product data service that provides enriched, standardized information about CAT machines, including specifications, features, and commercial attributes. For equipment dealers, it serves as an authoritative source of product master data that can be integrated into dealer systems to support sales, quoting, digital experiences, and downstream operational workflows via APIs.

For information on how Equipment CRM integrates with Prime Product+, see “Equipment CRM - Prime Product+ Integration”.

CAT Prime Product API Scope

  • Key: api.cat.pp.scope
  • Visibility: Public
  • Description: Defines the scope parameter used during authentication with Microsoft Entra to retrieve an access token for the Caterpillar Prime Product v3 API. The value should typically be {client_id}/.default, where client_id corresponds to the CAT Prime Product API Client ID. This format may evolve based on future Microsoft or Caterpillar specifications. When this configuration key is populated, the system will authenticate with Microsoft Entra rather than using the legacy Ping Federate authentication method.
  • Value: Provided by Caterpillar.

CAT Prime Product API Client ID

  • Key: api.cat.pp.clientid
  • Visibility: Public
  • Description: Sets the client ID used for authentication with the Prime Product API. This value is required when using the Microsoft Entra authentication provider.
  • Value: Provided by Caterpillar.

CAT Prime Product API Client Secret

  • Key: api.cat.pp.secret
  • Visibility: Public
  • Description: Sets the client secret used for authentication with the Prime Product API. This value is required when using the Microsoft Entra authentication provider.
  • Value: Provided by Caterpillar.

Basic Daily API

Caterpillar’s Basic Daily API provides standardized daily snapshots of equipment telematics data, including key metrics such as location, hours, and machine status. For equipment dealers, it serves as a reliable integration point for ingesting CAT machine data into dealer systems, supporting reporting, fleet visibility, and downstream service and operational workflows.

CAT Basic Daily API Scope

  • Key: CAT.BasicDaily.API.Entra.Auth.Scope
  • Visibility: Public
  • Description: Sets the Scope used for authentication with the CAT Basic Daily API. This value is required when using the Microsoft Entra authentication provider.
  • Value: Provided by Caterpillar.

CAT Basic Daily API Client Id

  • Key: CAT.BasicDaily.API.Entra.Auth.ClientId
  • Visibility: Public
  • Description: Sets the ClientId used for authentication with the CAT Basic Daily API. This value is required when using the Microsoft Entra authentication provider.
  • Value: Provided by Caterpillar.

CAT Basic Daily API Client Secret

  • Key: CAT.BasicDaily.API.Entra.Auth.ClientSecret
  • Visibility: Public
  • Description: Sets the ClientSecret used for authentication with the CAT Basic Daily API. This value is required when using the Microsoft Entra authentication provider.
  • Value: Provided by Caterpillar.

Cat Interact Dealer Integration API

Cat Interact (formerly Modern) is Caterpillar’s digital platform that provides centralized access to customer, equipment, and operational data across CAT systems. For equipment dealers, it acts as a connected ecosystem that surfaces machine and account insights, enabling integration with dealer systems and supporting workflows such as fleet management, service, and customer engagement through APIs.

See “Cat Interact” for an overview of Service Management CD’s integration with Cat Interact.

Workorder notification service enabled

  • Key: SVL.WorkOrderNotificationService.Enabled
  • Visibility: Internal
  • Description: Allows Service Management CD to call the Work Order Notification Service. This service is what Service Management CD uses to send notifications to Cat Interact.
  • Value: “Yes” (enabled) or “No” (disabled).

WorkOrderNotificationService Scope

  • Key: WorkOrderNotificationService.Scope
  • Visibility: Public
  • Description: Scope for the WorkOrderNotificationService authorization API, which returns the access token for CAT Interact. This is only used for EntraID, and if this is populated, will switch the logic to the EntraID version. Otherwise, it will use the older PingFed logic.
  • Value: Provided by Caterpillar.

User name for work order notification service

  • Key: WorkOrderNotificationService.UserName
  • Visibility: Internal
  • Description: Username that the Work Order Notification Service will use when requesting authorization from the Cat Interact API.
  • Value: Provided by Cat Interact.

Password for work order notification service

  • Key: WorkOrderNotificationService.Password
  • Visibility: Internal
  • Description: Password that the Work Order Notification Service will use when requesting authorization from the Cat Interact API.
  • Value: Provided by Cat Interact.

VisionLink

Caterpillar VisionLink is Caterpillar’s cloud-based telematics platform that provides equipment location, utilization, health, and maintenance data for CAT and supported third-party machines. For equipment dealers, VisionLink serves as the upstream data source for machine insights, enabling dealers to monitor customer fleets, support service operations, and integrate equipment data into their own systems via APIs.

As of June 2023, Caterpillar has deprecated their VisionLink v1 APIs and instructed all dealers and partners to migrate to v3. See “Upgrade VisionLink to v3” for more information.

ClientScope for VisionLink V3 Integration

  • Key: Integration.VisionLink.V3.ClientScope
  • Visibility: Public
  • Description: Configures ClientScope for VisionLink V3 Integration.
  • Value: Provided by Caterpillar.

ClientId for VisionLink V3 Integration

  • Key: Integration.VisionLink.V3.ClientId
  • Visibility: Public
  • Description: Configures ClientId for VisionLink V3 Integration.
  • Value: Provided by Caterpillar.

ClientSecret for VisionLink V3 Integration

  • Key: Integration.VisionLink.V3.ClientSecret
  • Visibility: Public
  • Description: Configures ClientSecret for VisionLink V3 Integration.
  • Value: Provided by Caterpillar.

ClientScope for VisionLink V3 Integration - Second Source

  • Key: Integration.VisionLink.V3.ClientScope_2ndSource
  • Visibility: Public
  • Description: Configures ClientScope of the Second Source for VisionLink V3 Integration.
  • Value: Provided by Caterpillar.

ClientId for VisionLink V3 Integration - Second Source

  • Key: Integration.VisionLink.V3.ClientId_2ndSource
  • Visibility: Public
  • Description: Configures ClientId of the Second Source for VisionLink V3 Integration.
  • Value: Provided by Caterpillar.

ClientSecret for VisionLink V3 Integration - Second Source

  • Key: Integration.VisionLink.V3.ClientSecret_2ndSource
  • Visibility: Public
  • Description: Configures ClientSecret of the Second Source for VisionLink V3 Integration
  • Value: Provided by Caterpillar.