The SnapGIS APIs provide seamless integration of asset data into third-party systems, allowing you to access real-time insights from vehicles, personnel, containers, and more—all through standardized, secure API endpoints. This enables easy data flow from SnapGIS into your BI, ERP, or other platforms.
\nTo authenticate with the SnapGIS Spark Platform, please follow these steps to create an API Key:
\n1. Log in to the SnapGIS Spark Platform.
\n2. Navigate to Settings > Integrations > Rest API.
\n3. Create a new API Key by following the on-screen instructions.
\n4. Once created, copy the ID and Secret values provided.
\n5. In Postman, set the following environment variables:
\n• key_id: Paste the ID from the new API Key here.
\n• key_secret: Paste the Secret associated with the API Key here.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23808710","collectionId":"c92c013f-a6e4-4017-a976-6950d754a987","publishedId":"2sAY4uCiZU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-28T20:42:47.000Z"},"item":[{"name":"asset-reports","event":[{"listen":"test","script":{"id":"0388e35f-5866-444e-a033-88873b085c07","exec":["// Parse the response JSON","let response = pm.response.json();","","// Set the value of 'nextTimestamp' to the environment variable 'nextFromTimestamp'","if (response.nextFromTimestamp) {"," pm.environment.set(\"nextFromTimestamp\", response.nextFromTimestamp);","}"],"type":"text/javascript","packages":{}}}],"id":"fd000244-1449-475c-87c5-1f9d8ab6f652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.snapgis.com/api/v1/external/asset-reports?fromTimestamp=2024-10-31T15:00:00.000Z","description":"This API provides a live data feed from the SnapGIS platform for all assets associated with the API key's assigned group, allowing external systems to continuously fetch the latest telemetry, event, or status updates in near real-time. It is typically used in automated loops to maintain an up-to-date data window synchronized with SnapGIS.
\nSet the fromTimestamp parameter in this request to specify the starting point for data retrieval:
• Manual Entry: Input a custom timestamp directly in the fromTimestamp parameter.
• Automatic Entry: Leave the fromTimestamp parameter set to the nextFromTimestamp environment variable. The nextFromTimestamp environment variable is automatically updated with the nextFromTimestamp value returned in the API response after each successful request.
Using nextFromTimestamp allows for seamless, continuous data retrieval based on the latest timestamp provided by the API.
\nRate limit: 6 requests per minute.
\nNote: The API is limited to returning 500 results in a single response.
\nNote: The API only supports retrieving data upto 14 days old. Passing a fromTimestamp older than 14 days will automatically return data starting from 14 days ago.
Automatic Entry
\n","type":"text/plain"},"key":"fromTimestamp","value":"{{nextFromTimestamp}}"},{"key":"fromTimestamp","value":"2024-10-31T15:00:00.000Z"}],"variable":[]}},"response":[],"_postman_id":"fd000244-1449-475c-87c5-1f9d8ab6f652"},{"name":"asset-recent","id":"fbe8e808-7ba3-4017-a30c-7d23d71e5376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.snapgis.com/api/v1/external/asset-recent","description":"Retrieve the most recent location and status data (including battery level, input voltage, and other parameters where suppoorted) for all assets associated with the API key’s assigned group.
\nOptionally apply one or more supported query parameters to filter results by specific asset attributes.
\nRate Limit: 6 requests per minute (per applied filter).
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"c92c013f-a6e4-4017-a976-6950d754a987","id":"c92c013f-a6e4-4017-a976-6950d754a987","name":"SnapGIS API Reference","type":"collection"}},"urlObject":{"path":["api","v1","external","asset-recent"],"host":["https://api.snapgis.com"],"query":[{"disabled":true,"description":{"content":"Asset name(s) on SnapGIS. Comma separated.
\n","type":"text/plain"},"key":"name","value":"Asset 1, Asset 2"},{"disabled":true,"description":{"content":"Device identifier(s) (IMEI, Terminal ID, Phone Number, etc) registered to the asset on SnapGIS.
\n","type":"text/plain"},"key":"deviceIdentifier","value":"123456789012332, 123456789012328"}],"variable":[]}},"response":[],"_postman_id":"fbe8e808-7ba3-4017-a30c-7d23d71e5376"},{"name":"asset-recent/{asset_type}","id":"a7cdadad-0b1b-47ba-9148-79a13773bede","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.snapgis.com/api/v1/external/asset-recent/","description":"Retrieve the most recent location and detailed information for all assets of a specified type within the group associated with the API key. This endpoint returns type-specific fields (for example, make, model, year, and registration for vehicles; ISO number and dimensions for containers; and so on).
\nOptionally apply one or more supported query parameters to filter results by asset attributes.
\nSupported type values: person, vehicle, vessel, vessel_ais, wellhead, pipeline, security_camera, container, trailer, general
\nRate Limit: 6 requests per minute (per applied filter).
\nNote: Query filter 'registrationNo' only works when 'asset_type' set to 'vehicle'.
\nNote: Query filter 'containerIso' only works when 'asset_type' set to 'container'.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"c92c013f-a6e4-4017-a976-6950d754a987","id":"c92c013f-a6e4-4017-a976-6950d754a987","name":"SnapGIS API Reference","type":"collection"}},"urlObject":{"path":["api","v1","external","asset-recent",""],"host":["https://api.snapgis.com"],"query":[{"disabled":true,"description":{"content":"Asset name(s) on SnapGIS. Comma separated.
\n","type":"text/plain"},"key":"name","value":"Asset 1, Asset 2"},{"disabled":true,"description":{"content":"Device identifier(s) (IMEI, Terminal ID, Phone Number, etc) registered to the asset on SnapGIS.
\n","type":"text/plain"},"key":"deviceIdentifier","value":"123456789012332, 1234567890123281"},{"disabled":true,"description":{"content":"Registration number (license plate) registered on SnapGIS.
\n","type":"text/plain"},"key":"registrationNo","value":"QW 123 456, XO 987 654"},{"disabled":true,"description":{"content":"Container ISO registered on SnapGIS.
\n","type":"text/plain"},"key":"containerIso","value":"MSCU 123456 5, TGHU 765432 3"}],"variable":[]}},"response":[],"_postman_id":"a7cdadad-0b1b-47ba-9148-79a13773bede"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"1fa080f5-ae7d-4f83-b257-6064cf4833e6"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"9234eff8-2042-4de8-bb51-e0f5c7ef1e8e"}}],"variable":[{"id":"37adf3fe-71cd-47f9-b131-5ad2c0674f55","key":"base_url","value":"https://api.snapgis.com"},{"id":"ae2f1ae2-ebae-471a-b36b-6b31723496ed","key":"key_id","value":""},{"id":"555f617b-61a2-4640-93f8-d24ed06f1877","key":"key_secret","value":""},{"id":"816848fd-276d-438f-9fa1-6e61b799c503","key":"asset_type","value":""}]}