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.
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. |
Click on the import button |
Following popup window will open: |
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, |
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
8) Green tick Mark with Authentication Complete
9) Click on Use Token
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 : Response Sample:
|
|
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 : Response Sample:
|
|
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 : 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 |