{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"f6e807cc-4d8d-46d7-808f-7af7fc7e815b","name":"[PROD] Loconav Developer APIs","description":"## LocoNav Integration Documentation\n\nWelcome to LocoNav's comprehensive set of REST APIs and webhooks, designed to seamlessly integrate LocoNav's robust solutions into your platform. Our APIs cover key areas such as telematics, safety, connected driver features, and more, empowering partners to track, trace, and manage assets efficiently.\n\n---\n\n## Types of APIs\n\n##### CRUD APIs\n\n- CRUD (Create, Read, Update, Delete) APIs provide basic operations for managing resources.\n    \n\n##### Telematics APIs\n\n- Telematics APIs offer access to sensor data, GPS locations, videos, and live streams related to vehicles.\n    \n\n##### Webhooks\n\n- Webhooks facilitate real-time notifications for alerts and live location updates.\n    - **`Alerts`**: Receive real-time notifications for various alerts such as speeding, geofence violations, etc via [Alert webhooks](https://developers.loconav.com/#a00a82fb-657b-4991-b8cb-ba0f15d5df7a).\n    - **`GPS Live Locations`**: Get instant updates on the live locations of vehicles or assets via [location webhooks](https://developers.loconav.com/#65830f41-7cdb-40dd-b723-482c8484914e).\n\n---\n\n## Base URLs\n\n- `api.a.loconav.com` for Global customers\n- `sa.loconav.com` for KSA customers\n- `om.loconav.com` for OMAN customers\n- `np.loconav.com` for NEPAL customers\n    \n\n---\n\n## Authentication\n\n#### Mechanism\n\nTo access LocoNav APIs, use the User Token provided for user-level authentication. Each user in our system is assigned a unique auth token. For your specific token details and access to the live token and testing environment, please reach out to your designated LocoNav point of contact (SPOC).\n\nHeader Name: **`User-Authentication`**\n\n#### Obtaining Authentication Token\n\nTo obtain your authentication token and details for testing environments, kindly get in touch with your LocoNav SPOC. They will assist you in acquiring the necessary credentials for a secure and seamless integration.\n\n---\n\n### Notes for API Usage\n\n1. **Time Requirement**: APIs that utilize time ranges or time parameters like `startTime` and `endTime` in requests necessitate the use of Epoch timestamps in seconds exclusively.\n2. **Authentication Handling**: Users will receive a `401 Unauthorized` response if authentication credentials are incorrect or not provided properly in the request headers.\n3. **Pagination Requirement**: All listing APIs are paginated, and a pagination object must be included in requests to navigate through pages effectively.\n4. **Rate Limiting**: Each API endpoint is subject to rate limiting. If an API is called more than 500 times within a 60-second rolling window, it will be throttled, and a `429 Too Many Requests` error will be returned to prevent abuse and ensure fair usage.\n    \n\n---\n\nConact the Developer at [developers@loconav.com](https://mailto:developers@loconav.com)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18930345","collectionId":"f6e807cc-4d8d-46d7-808f-7af7fc7e815b","publishedId":"2s9YeHZAqq","public":true,"publicUrl":"https://developers.loconav.com","privateUrl":"https://go.postman.co/documentation/18930345-f6e807cc-4d8d-46d7-808f-7af7fc7e815b","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009688"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"009688"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"009688"}}]}},"version":"8.10.1","publishDate":"2024-01-03T09:21:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Staging","id":"3cc96cd0-44a6-482e-a854-483a439757da","owner":"17278093","values":[{"key":"base_url","value":"http://ind-stg-marketplace.loconav.com","enabled":true},{"key":"user_id","value":"19","enabled":true},{"key":"admin_auth","value":"hA7CgCwh6dyW-CqofsHt","enabled":true},{"key":"auth","value":"02c2cd28-1123-11ec-82a8-0242ac130003","enabled":true},{"key":"active","value":"","enabled":true},{"key":"device_type_id","value":"","enabled":true},{"key":"created_on","value":"13/12/2021","enabled":true},{"key":"page","value":"1","enabled":false},{"key":"per_page","value":"10","enabled":true},{"key":"serial_number","value":"","enabled":true},{"key":"id","value":"374","enabled":true},{"key":"user_token","value":"ga4e9qruGSsyZdsxsoxz","enabled":true},{"key":"vehicle_number","value":"MOCKDEVICETESTING1","enabled":true},{"key":"sort_order","value":"asc","enabled":true},{"key":"sort_column","value":"start_time","enabled":true},{"key":"start_time","value":"1639929600","enabled":true},{"key":"end_time","value":"1640005516","enabled":true},{"key":"start_time_from","value":"1639929600","enabled":true},{"key":"start_time_till","value":"1639929600","enabled":true},{"key":"vehicle_id","value":"733","enabled":true},{"key":"number","value":"DEOSUB1231","enabled":true},{"key":"vehicle_ids","value":"10,13,15","enabled":true},{"key":"include_yday","value":"true","enabled":true},{"key":"driver_name","value":"Test","enabled":true},{"key":"reject_id","value":"259","enabled":true},{"key":"driver_id","value":"259","enabled":true},{"key":"document_resource_id","value":"12","enabled":true},{"key":"document_resource","value":"vehicle","enabled":true},{"key":"doc_field_type_id","value":"74","enabled":true},{"key":"doc_field_value","value":"test","enabled":true},{"key":"doc_type_id","value":"5","enabled":true},{"key":"document_id","value":"968","enabled":true},{"key":"page","value":"1","enabled":true},{"key":"start_time","value":"1642917090","enabled":false},{"key":"end_time","value":"","enabled":false},{"key":"asset_attached_at_from","value":"1652597942","enabled":true},{"key":"asset_attached_at_till","value":"1652943753","enabled":true},{"key":"asset_id","value":"5956","enabled":true},{"key":"asset_type","value":"vehicle","enabled":true},{"key":"code","value":"SUB00FP0007500000769","enabled":true},{"key":"created_at_from","value":"1652597942","enabled":true},{"key":"created_at_till","value":"1652943753","enabled":true},{"key":"created_by","value":"ADMIN99","enabled":true},{"key":"current_page","value":"0","enabled":true},{"key":"duration","value":"2","enabled":true},{"key":"duration_unit","value":"MONTHS","enabled":true},{"key":"expires_at_from","value":"1652597942","enabled":true},{"key":"expires_at_till","value":"1652943753","enabled":true},{"key":"expiring_soon","value":"false","enabled":true},{"key":"franchise_partner_id","value":"75","enabled":true},{"key":"has_started","value":"false","enabled":true},{"key":"ids","value":"","enabled":true},{"key":"sort_by","value":"id","enabled":true},{"key":"started_at_from","value":"1652597942","enabled":true},{"key":"started_at_till","value":"1652943753","enabled":true},{"key":"statuses","value":"ACTIVE,INACTIVE","enabled":true},{"key":"subscription_type","value":"vehicle","enabled":true},{"key":"terminated_at_from","value":"1652597942","enabled":true},{"key":"terminated_at_till","value":"1652943753","enabled":true},{"key":"unique_id","value":"","enabled":true},{"key":"updated_at_from","value":"1652597942","enabled":true},{"key":"updated_at_till","value":"1652943753","enabled":true},{"key":"updated_by","value":"ADMIN99","enabled":true},{"key":"vehicle_numbers","value":"TESTVEH1,TESTVEH2,TESTVEH3","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://loconav.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Staging","value":"17278093-3cc96cd0-44a6-482e-a854-483a439757da"}],"canonicalUrl":"https://developers.loconav.com/view/metadata/2s9YeHZAqq"}