API GUIDELINES

Executive Summary

DEVELOPMENT FOCUS
CATERPILLAR DEALERS
  • Provide dealers free access to Cat Basic Daily API to drive aftermarket leads and support aftermarket and services growth (not to be used by dealers to develop customer facing Apps).
  • Manage the full offering of APIs, from “freemium” to premium, to maintain competitiveness in the marketplace.
  • Make certain APIs available to dealers to innovate for unique regional or customer needs, while staying aligned to these Guidelines.
     
  • Leverage data and APIs wherever possible from HELIOS, the Cat Digital platform, to ensure a single source of truth in data across Caterpillar and dealer applications.
  • Propose use cases for new APIs and services that are designed to create efficiencies, value and improve or solve business challenges (via the Cat Digital Marketplace).
  • Request access for APIs from existing Caterpillar applications (via the Cat Digital Marketplace) and provide Cat Digital with input where additional application features or functionality could negate the need for an API. 

 

API GUIDELINES

The following guidelines are intended to provide a framework for the development and use of APIs between Caterpillar and dealers.

OPERATIONAL DEFINITION

The APIs discussed in this section are in place to support and/or complement existing Caterpillar applications, and where applicable, to enable dealers to develop solutions where Caterpillar solutions do not exist, or where there are unique regional or customer needs.  APIs and services will consume from the Helios platform, will be made available to dealers via the Cat Digital Marketplace and will be managed using the Apigee Services Manager.

 

CATERPILLAR POSITION STATEMENTS
  • Caterpillar will continue to provide the Cat Basic Daily API to dealers to drive aftermarket leads, to support dealer aftermarket and services growth and to enable dealer operational efficiencies. 
  • Assets in the Basic Daily API are based on Subscription level and today all Commercial Subscriptions are made available to this API.APIs that are provided at no cost to the dealer are not intended for use by dealer in building customer facing applications (consistent withCaterpillar’s API license agreement.).
  • Caterpillar will manage the full suite of API offerings, positioning “freemium” offerings to maintain market competitiveness and premium offerings that can provide differentiated value.  
  • Caterpillar will commercialize APIs that include increased data, capabilities and update frequency.  Where an API may enable dealers to innovate for unique customer or regional needs, Caterpillar may commercialize APIs.
  • Commercialized APIs are intended for dealers to utilize in dealer developed customer facing applications.  
  • Caterpillar will provide controls, including monitoring and limiting the usage of APIs.
  • Dealer applications will leverage data and APIs wherever possible from HELIOS, the Cat Digital platform, to ensure single source of truth in data across Caterpillar and dealer applications. 
  • Dealers are expected to request access for APIs from existing applications when developing solutions for unique customer needs, and to provide input to Caterpillar where Caterpillar solutions do not meet specific customer or regional needs.  
    • Instructions on how to request access for APIs coming soon!
    • Instructions on where to find the APIs coming soon!
    • Instructions on where to submit new use case ideas for potential API development coming soon!
       
/apis/products/prod/iso-15143-3-aemp-20-api