CalAmp Telematics Cloud

What you can build

• Notice when an asset leaves its zone

  Geozone membership rides on each event. The operator watches for an asset reporting outside its geozone and proposes a notice to the owner with the last known position.

  With Route Deviation

• Act on a J1939 fault

  dtcEvent and J1939 fault reports arrive through the Data Pump with device and time. The operator groups them per asset and proposes a service booking with the codes attached.

  With Vehicle Fault

• Answer where it is

  Current asset state gives latitude, longitude, heading, and time of fix. The operator computes an arrival window and proposes the update a dispatcher sends.

  With ETA Notice

• Schedule by engine hours

  Events carry accumulators such as odometer and engine hours. The operator projects when each asset reaches its service point and proposes the booking date.

  With Service Interval

Requirements

• A CTC account with a user login and an application key, since every call carries calamp-services-app or x-app-key
• An API version on each request, as v=2.1 or later, for endpoints that enforce pagination
• For Custom Destination Streaming, a queue or topic you own: AWS SQS standard queue, AWS Kinesis, Kafka with SASL SCRAM or PLAIN, or Google Pub/Sub
• For the Data Pump, a poller that reads at least every 48 hours, or the queue is disabled

Authentication

A Bearer access token from the CalAmp token endpoint at accounts.calamp.com using grant_type password with username, password, client_id, and scope, sent with the calamp-services-app application key header; the API conventions also document an authToken cookie with the calamp-services-app or x-app-key header.

Limits

• CTC rate limiting is up to 200 calls per minute, with login APIs under separate guidance
• Pagination uses pg and pgsize; pgsize defaults to 10 and caps at 100 on Entity Services, and at 500 on the Results events endpoint
• Data Pump messages are removed once retrieved, so a poller must persist what it reads
• An access token expires after 24 hours; the authToken cookie lapses 3600 seconds after the last request

Questions and answers

How does event data reach my system?

Three ways. The Data Pump is a FIFO queue you poll with GET /events; it activates on the first call and holds every event for the account and subaccounts. Results Services return history by device and date. Custom Destination Streaming pushes messages to AWS SQS, AWS Kinesis, Kafka, or Google Pub/Sub.

What does a request need besides the token?

An application key in the calamp-services-app or x-app-key header, an API version such as v=2.1, and JSON. Responses are JSON only and UTF-8; XML support was discontinued. Paged responses carry totalCount and _links for first, prev, next, and last.

How fast does streaming deliver?

It depends on the destination. Kinesis batches are pushed at least every 100ms, or when a batch reaches 256KB or 500 messages. SQS receives messages as they arrive. Kafka timing follows the producer properties you set. Oversized messages are ZLIB-compressed and Base64-encoded.