Back

ISO 15143-3 (AEMP 2.0) API - Access Guide

  • APIs
  • ISO 15143-3 (AEMP 2.0) API
Mohamed Shajahan Raja Mohamed 05/20/2022 - 11:55 AM

This Article helps API consumer with testing their credentials for CAT ISO 15143-3 (AEMP 2.0) API and understand ways of accessing the API.

ISO-1

 

 

 

 

 

To Validate the API Access using Postman, follow the below steps:

This Article guides you with ISO 15143-3 (AEMP 2.0) API connectivity testing using Postman (3rd party software) as the API connectivity testing tool (You can download Postman from (https://www.postman.com/downloads/)

Step 1 : How to import Postman Collection

1) Download JSON collection from the below link which needs to be imported into Postman once the credentials are issued.

https://digital.cat.com/knowledge-hub/document ( Search for "ISO 15143-3 (AEMP 2.0) API - Postman Collection")

2) Import ISO15143 API (AEMP 2.0) Postman Collection

You can click on “Skip and go to the app” to import the Postman collections.

ISO-2

Click on the import button 

ISO-2

Following popup window will open:

ISO-3

Click on “Choose Files” button. Select postman collection obtained from Caterpillar API Adoption Team (usually as a set of JSON files attached with the Adoption Meeting invitation).

On successful import, you can see ISO15143 API (AEMP 2.0) endpoints as shown below, select the Fleet Snapshot - JSON endpoint,

ISO-4

Step 2 : Getting Access token

Pre Request : User requested for API Access and credentials are already issued by Caterpillar

Token is generated successfully.

1) Select Authorization

2) Type : OAuth 2.0

3) Grant Type : Client Credentials

4) Access Token URL : https://fedlogin.cat.com/as/token.oauth2

5) Client ID : XXXXXXX_cc_client

6) Client Secret : XXXrchXXXXXMpOXXXXXXXXXXXXXXX

7) Click on the "Get New Access Token" button

ISO-5

8) Green tick Mark with Authentication Complete

ISO-6

9) Click on Use Token

ISO-7

Step 3: Accessing the Endpoints

Fleet Snapshot

End Point URL:

https://services.cat.com/telematics/iso15143/fleet/1

Header: 

Accept : application/iso15143-snapshot+json 

or

Accept : application/iso15143-snapshot+xml 

Click Send Button to get the response, status will be 200 and response is highlighted below :

ISO-8

Response Sample:

 "Equipment": [
        {
            "EquipmentHeader": {
                "OEMName": "CAT",
                "Model": "938M",
                "EquipmentID": "XXXXX621",
                "SerialNumber": "XXXXXX"
            },
            "Location": {
                "Latitude": 44.163350,
                "Longitude": 4.146740,
                "Altitude": 201.000000,
                "AltitudeUnits": "metre",
                "Datetime": "2022-04-15T18:06:30Z"
            },
            "CumulativeIdleHours": {
                "Hour": 1120.2,
                "Datetime": "2022-04-15T18:06:30Z"
            },
            "CumulativeOperatingHours": {
                "Hour": 7496.3,
                "Datetime": "2022-04-15T18:06:30Z"
            },
            "CumulativePayloadTotals": {
                "PayloadUnits": "kilogram",
                "Payload": 1418969664000.0,
                "Datetime": "2020-08-21T05:09:38Z"
            },
            "Distance": {
                "OdometerUnits": "kilometre",
                "Odometer": 7217.6,
                "Datetime": "2022-04-15T18:06:30Z"
            },
            "EngineStatus": {
                "EngineNumber": "XXXXX",
                "Running": true,
                "Datetime": "2022-04-15T18:15:19Z"
            },
            "FuelUsed": {
                "FuelUnits": "litre",
                "FuelConsumed": 80624,
                "Datetime": "2022-04-15T18:06:30Z"
            },
            "FuelUsedLast24": {
                "FuelUnits": "litre",
                "FuelConsumed": 129,
                "Datetime": "2022-04-14T00:00:00Z"
            },
            "FuelRemaining": {
                "Percent": 32.0,
                "Datetime": "2022-04-15T18:06:30Z"
            }
        }

Equipment Snapshot (individual)

End Point URL:

https://services.cat.com/telematics/iso15143/fleet/equipment/makeModelS…

Header: 

Accept : application/iso15143-snapshot+json 

or

Accept : application/iso15143-snapshot+xml 

Click Send Button to get the response, status will be 200 and response is highlighted below :

ISO-9

Response Sample:

 "Equipment": [
        {
            "EquipmentHeader": {
                "OEMName": "CAT",
                "Model": "XXXD L",
                "SerialNumber": "XXXX"
            },
            "Location": {
                "Latitude": 42.520770,
                "Longitude": 2.030550,
                "Altitude": 1965.000000,
                "AltitudeUnits": "metre",
                "Datetime": "2022-04-14T23:30:19Z"
            },
            "CumulativeIdleHours": {
                "Hour": 1058.9,
                "Datetime": "2022-04-14T23:30:19Z"
            },
            "CumulativeOperatingHours": {
                "Hour": 9665.7,
                "Datetime": "2022-04-14T23:30:19Z"
            },
            "Distance": {
                "OdometerUnits": "kilometre",
                "Odometer": 85.4,
                "Datetime": "2022-04-14T23:30:19Z"
            },
            "EngineStatus": {
                "EngineNumber": "XXX",
                "Running": false,
                "Datetime": "2022-04-14T13:27:23Z"
            },
            "FuelUsed": {
                "FuelUnits": "litre",
                "FuelConsumed": 143043,
                "Datetime": "2022-04-14T23:30:19Z"
            },
            "FuelUsedLast24": {
                "FuelUnits": "litre",
                "FuelConsumed": 56,
                "Datetime": "2022-04-14T00:00:00Z"
            },
            "FuelRemaining": {
                "Percent": 79.0,
                "Datetime": "2022-04-14T23:30:19Z"
            }
        }

Timeseries-Fault

End Point URL:

https://services.cat.com/telematics/iso15143/fleet/equipment/makeModelS…

Click Send Button to get the response, status will be 200 and response is highlighted below :

ISO-10

Response Sample: 

 "FaultCode": [

        {

            "CodeIdentifier": "1952-9",

            "CodeDescription": "Chassis Angle Sensor:Abnormal Update Rate",

            "CodeSeverity": "Medium",

            "CodeSource": "Implement Control #2",

            "Datetime": "2022-04-13T20:02:24Z"

        },

        {

            "CodeIdentifier": "4576-3",

            "CodeDescription": "Bucket Angle Sensor:Voltage Above Normal",

            "CodeSeverity": "Low",

            "CodeSource": "Machine Control",

            "Datetime": "2022-04-13T19:45:32Z"

        },

        {

            "CodeIdentifier": "2402-9",

            "CodeDescription": "Laser Receiver:Abnormal Update Rate",

            "CodeSeverity": "Low",

            "CodeSource": "Implement Control #2",

            "Datetime": "2022-04-13T19:42:44Z"

        },

]

Additional Documentation

The following additional documentation is available as part of the Basic Daily API bundle:

Document Name Description Path
ISO 15143-3 (AEMP 2.0) API - Postman Collection Provides JSON endpoint collection to be imported to Postman https://digital.cat.com/knowledge-hub/document

Related Articles

Overview

ISO 15143-3 API provides general information for tracking assets, understanding their usage, and planning how to manage those assets.

This Article helps API consumer with testing their credentials for CAT ISO 15143-3 (AEMP 2.0) API and understand ways of accessing the API.

GAIN FULL VISIBILITY INTO YOUR OPERATIONS 

/apis/products/prod/iso-15143-3-aemp-20-api