Amcrest GPS API Documentation
1. Registration This API allow user to register Device in application. API Link - https://api.amcrestgps.net/auth/register Method - POST *Example Request Payload { first_name:"mayur", last_name:"patil", email:"mayur1@gmail.com", company:"amcrest", phone_number:"7894561230", password:"password", comfirm_email:"mayur1@gmail.
Response { message: "User Register Successfully", status: true, status_code: 201, details: { id: 11, first_name: "mayur", last_name: "patil", email: "mayur1@gmail.
subscription_status: "Active", imei_no: "01234567899", device_name: "device_name", device_model: "device_model", imei_iccid: null, sim_status: 1, ip_address: null, start_date: "2019-02-12", end_date: "2019-03-11", firstBillingDate: "2019-02-12", nextBillingDate: "2019-03-12", order_id: null } ] } 2. Login This API used to login into app, login API introduce login token and token used to access API’s. API Link - https://api.amcrestgps.
"company": “User Company”, "time_zone": “User Timezone”(eg. US/Central), "language": “English”, "uom": "kms", "last_login": "2019-05-20T06:08:42.799810Z" }, "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VybmFtZSI6ImFkbWl uQGFtY3Jlc3QuY29tIiwiZXhwIjoxNTU4NTIyOTU1LCJlbWFpbCI6ImFkbWluQGFtY3Jlc3QuY29t Iiwib3JpZ19pYXQiOjE1NTgzNTAxNTV9.oSSTvfqhrPyjneeTEOH-vCzDejHvOUkEFND7AHagt0", "status": true, "message": "User logged in successfully", "status_code": 200, "master_password": false } 3.
status: true, subscriptions: [ { id: 49, gps_id: 66, customer_id: 546171441, subscription_id: "jy42y2", transaction_id: "h936yrj4", subscription_status: "Active", imei_no: "0123456789102", device_name: "device_name1", device_model: "device_model", imei_iccid: null, sim_status: 1, ip_address: "127.0.0.
4. Reactivation API to reactivate device subscription. API link - https://api.amcrestgps.
order_id: null } } 5. Get Inactive Devices Get inactive devices API returns the inactive devices of customer/user API link - https://api.amcrestgps.net/auth/re-activation/devices/ Method - GET *Example API - https://api.amcrestgps.
API - https://api.amcrestgps.net/auth/re-activation/device/info/530558961/797824723490902 Response { message: "inactive device details", status_code: 200, status: true, device: { id: 55, customer_id: 530558961, imei_no: "797824723490902", imei_iccid: "12546565464648646" }, user_details: { first_name: "User first name", last_name: "User last name", email: "user@domain.
8. Sim Deactivate API This API use to Deactivate SIM API Link - https://api.amcrestgps.net/support/sim/deactivate/ Method - GET * Example Request API - https://api.amcrestgps.net/support/sim/deactivate/797824723490902 Response { message: "Sim Activated Successfully", status: true, status_code: 200 } 9. Device plan Update Using this API user can update device API Link - https://api.amcrestgps.
status: true, subscription: { id: 75, gps_id: 36, customer_id: 494943711, subscription_id: "bqywgb", transaction_id: "bph19aqj", subscription_status: "Active", imei_no: "797824723490902", device_name: "Device 1", device_model: "gl300-4g", imei_iccid: "89462046051002298870", sim_status: false, ip_address: null, start_date: "2019-03-18", end_date: "2019-04-17", firstBillingDate: "2019-03-18", nextBillingDate: "2019-04-18", activated_plan_id: "monthly", activated_plan_description: "19.
11. Cancel Subscription This API used to Cancel Subscription. API - https://api.amcrestgps.net/auth/subscription/cancel Method - POST *Example Request { First_name:"firstName", last_name:"lastName", email:"email@domain.com", phone_number:"55555555555", imei:"797824723490902", cancelation_reason:"test cancel", how_gps_tracker:"good", comment:"test comment" } Response { message: "Subscription Cancelled", status: True, status_code: 404 } 12. Return Device This API use to return device. API - https://api.
. Update Credit card Use this API to Update Credit Card Details. API - https://api.amcrestgps.net/auth/credit-card/update Method - POST *Example Request { email:"user@domain.com", credit_card:{ Cardholder_name:"card holder name", cvv:"123", expiration_date:"01/21", number: "4111111111111111" } } Response { message: "updated card Details", status: true, status_code: 200 } 14. Validate Credit Card Before you update credit card, you have to validate previous credit card.
status_code: 200, response: { first_name: "firstName", last_name: "lastName", last4: "1111" } } 15. Get Device List Get Activated Device List. API Link - https://api.amcrestgps.net/api/devices/?category= Category -> 1. gps 2. obd *Example Request https://api.amcrestgps.
gps_id: 286, customer_id: 841768718, imei_no: "864251020319244", device_name: "Device 2", id: 2, device_details: { engine_rpm: 0, engine_coolant_temp: 78, speed: 0, longitude: 85.815785, latitude: 20.356115, mileage: 43.5, send_time: 20181228132117, fuel_level_input: null, vehicle_speed: 0, obd_power_voltage: 12988, device_status:"220000" } } ], status: true, status_code: 200 } 16. Create Zone Using this API user can create zone API Link - https://api.amcrestgps.
{ message: "Zone Created Successfully", status_code: 201, status: true, zone: { id: 1, name: "Test zone", coordinates: "[{'lat' : '25.535345', 'lng' : '987.213123'}, {'lat' : '25.535345', 'lng' : '987.213123'}]", type: "keep-in", customer_id: "841768718", status: true, created_on: "2019-01-03T11:54:47.576914Z", updated_on: "2019-01-03T11:54:47.576968Z", zone_group: null } } 17. Get Zone List Get created zone list API Link - https://api.amcrestgps.
18. Zone Update API This API used to update Zone API - https://api.amcrestgps.net/api/zones/zone/ Method - PUT *Example Request API - https://api.amcrestgps.net/api/zones/zone/1 Payload { name: "Test zone", coordinates: "[{'lat' : '25.535345', 'lng' : '987.213123'}, {'lat' : '25.535345', 'lng' : '987.
*Example Request API - https://api.amcrestgps.net/api/zones/zone/1 Response { message: "Zone Deleted Successfully", status: true, status_code: 204 } 20. Zone Alert Create Create Zone alert. API Link - https://api.amcrestgps.net/api/zone_alert Method - POST *Example Request API - https://api.amcrestgps.net/api/zone_alert Payload { zones:[, , ....] imei:[, ], name:"Testing Zone Alert", email_one:"email_one@gmail.com", email_two:"email_two@gmail.
Update zone alert details. API link - https://api.amcrestgps.net/api/zone_alert Method - PUT *Example Request Payload { id: 7, name: "Testing Zone Alert 1", phone_two: null, phone_one: "9019802163", email_one: "is@amcrest.com", email_two: "mayur1@gmail.com", type: "keep-in", customer_id: "607863292", zone: 2 } Response { message: "Zone Alert updated Successfully", status_code: 204, status: true } 22. Delete Zone Alert Delete zone alert API Link - https://api.amcrestgps.
{ message: "Zone Alert Deleted Successfully", status: true, status_code: 204 } 23 . Get Device Settings Get Device Settings API Link - https://api.amcrestgps.net/api/device/settings/ Method - GET *Example Request API - https://api.amcrestgps.net/api/device/settings/864251020319244 Response { message: "Get Settings for the device success", status: true, status_code: 200, settings: { id: 1, imei: "864251020319244", trip_notification: false, trip_email: "email@email.
trip_end_timer: 3, device_name:"device 1" } } 24. Update Device Settings API link - https://api.amcrestgps.net/api/device/settings/ Method - PUT *Example Request API - https://api.amcrestgps.net/api/device/settings/864251020319244 { id: 1, imei: "864251020319244", trip_notification: false, trip_email: "updateemail@email.com", trip_sms: "+919019802163", engine_notification: true, engine_email: "email@email.
25. Get Device settings list API Link - https://api.amcrestgps.net/api/setting/devices/ Method - GET *Example Request API - https://api.amcrestgps.net/api/setting/devices/123456 Response { message: "settings of device", status_code: 200, status: true, settings: [ { id: 1, imei: "864251020319244", trip_notification: false, trip_email: "updateemail@email.com", trip_sms: "+919019802163", engine_notification: true, engine_email: "email@email.
26. Country List API to get country list, while registering device API - https://api.amcrestgps.net/info/countries Method - GET *Example Response { message: "Country List", status: true, status_code: 200, countries: [{ id: 1, country_name: "Afghanistan", country_iso_code: "AF", country_iso_code_2: "AFG" }, .... { id: 250, country_name: "United States", country_iso_code: "US", country_iso_code_2: "USA" }] } 27. State List API to get state list based on country. API - https://api.amcrestgps.
id: 65, country: "250", state_code: "WY", state_name: "Wyoming" }], status_code: 200 } 28. Get list of langauges API - https://api.amcrestgps.net/info/langauges Method - GET *Example Request API - https://api.amcrestgps.net/info/langauges Response { message: "List of Langauges", status: true, status_code: 200, langauges: [{ id: 6, code: "aa", value: "Afar" }, ..... { id: 603, code: "zza", value: "Zaza" }] } 29.
"time_zone": [{ "id": 1, "description": "(UTC-12:00) International Date Line West", "time_zone": "Pacific/Midway" }, { "id": 2, "description": "(UTC-11:00) Coordinated Universal Time-11", "time_zone": "Pacific/Midway" }, .... { "id": 98, "description": "(UTC+13:00) Samoa", "time_zone": "Pacific/Tongatapu" }] } 30. Validate IMEI Use API to validate IMEI before registration/activation. API - https://api.amcrestgps.net/info/imei_validation/ Method - GET *Example Request API - https://api.amcrestgps.
31. Odometer Event List List of odometer Events in date range API - https://api.amcrestgps.net/api/events/odometer//?from=date-monthyear&to=date-month-year Method - GET *Example Request API - https://api.amcrestgps.net/api/events/odometer/123456/864251020319244?from=23-012019&to=24-01-2019 Response { message: "Odometere details", from_date: "23-01-2019", to_date: "24-01-2019", odometere: [{ id: 1, imei: "864251020319244", distance: 6.
*Example Request API - https://api.amcrestgps.net/api/events/odometer/123456/864251020319244?date=23-01-2019 Response { message: "Odometere details", date: "23-01-2019", odometere: { id: 1, imei: "864251020319244", distance: 6.0, record_date: "2019-01-23", record_date_timezone: "2019-01-23" }, status_code: 200, status: true } 33. Voltage Event Get Voltage Events in date range and for single date API - https://api.amcrestgps.
...... { id: 5, imei: "864251020319244", min_voltage: 12779.0, max_voltage: 13787.0, avg_voltage: 13333.4, record_date: "2019-01-24" } ], status_code: 200, status: true } 34. Voltage Event for particular date Get voltage Event for particular date API - https://api.amcrestgps.net/api/events/voltage//?date=date-month-year *Example API - https://api.amcrestgps.
Method - GET *Example Request API https://api.amcrestgps.net/api/events/harsh_behaviour/123456/864251020319244? from=23-01-2019&to=26-01-2019 Response { message: "Harsh Events details", from_date: "23-1-2019", to_date: "26-1-2019", harsh_event: [{ id: 1, imei: "864251020319244", harsh_type: "low speed harsh breaking behaviour", record_date: "2019-01-23", record_time: "17:26:37.
API - https://api.amcrestgps.net/api/events/harsh_behaviour/123456/864251020319244?date=23-012019 Response { message: "Harsh Events details", date: "23-1-2019", harsh_event: [{ id: 2, imei: "864251020319244", harsh_type: "low speed harsh breaking behaviour", record_date: "2019-01-23", record_time: "17:31:13.325901" }, { id: 1, imei: "864251020319244", harsh_type: "low speed harsh breaking behaviour", record_date: "2019-01-23", record_time: "17:26:37.234880" }], status_code: 200, status: true } 37.
zip: "111111", country: "country", customer_id: 268102, company: "Amcrest", time_zone: "Asia/Kolkata", language: "it" }, status_code: 200, status: true } 38. Update User Profile Here user can update their profile. API - https://api.amcrestgps.net/auth/user/profile/ Method - PUT *Example Request API - https://api.amcrestgps.
39. Get Location To find the location using longitude and latitude. API - https://api.amcrestgps.net/api/location// Method - GET *Example Request API - https://api.amcrestgps.net/api/location/84.798752/19.310547 Response { "message": "Retrieving location successful", "status_code": 200, "status": true, "location": { "longitude": “84.798752”, "latitude": “19.310547”, "location_name: “Hati Bandha Street, Manjari Nagar, Brahmapur, Odisha 760001” } } 40.
b. Reset Password (Token Required) API - https://api.atozecommerce.in/auth/reset/password Method - POST Request { password:Info@1234, confirm_password:Info@1234, email:useremail@domain.com } Response { message: "Password Reset Successfull", status_code: 200, status: true } 41. Change Password To change existing password, use this API. API - https://api.amcrestgps.net/auth/change_password/ Method - POST *Example Request API - https://api.amcrestgps.net/auth/change_password/useremail@domain.
Method - POST a. Website Token API - https://api.amcrestgps.net/api/notification/token Request Payload { customer_id:"8018742", website:"w43r432rf2r24r3r", category : obd/gps } b. Android Token API - https://api.amcrestgps.net/api/notification/token Request Payload { customer_id:"8018742", android:"w43r432rf2r24r3r", category : obd/gps } c. ios Token API - https://api.amcrestgps.
b. Website Token API - https://api.amcrestgps.net/api/notification/remove/token Request Payload { customer_id:"8018742", website:null, category : obd/gps } b. Android Token API - https://api.amcrestgps.net/api/notification/remove/token Request Payload { customer_id:"8018742", android:null, category : obd/gps } c. ios Token API - https://api.amcrestgps.
{ trip_dates:[ { start:20190204051414, end:20190205121416 }, { start:20190204051414, end:20190205121416 } ] } Response { message: "Engine Summary", status: true, status_code: 200, engine_summary: [ { id: 110, date: "28/01/2019", time: "11:07:12", protocol_version: "360901", imei: "864251020319244", device_name: null, journey_fuel_consumption: null, max_rpm: 1623, average_rpm: 1381, max_throttle_position: 23, average_throttle_position: 17, max_engine_load: 58, average_engine_load: 34, gps_accuracy: 0, speed
date: "28/01/2019", time: "11:07:12", protocol_version: "360901", imei: "864251020319244", device_name: null, journey_fuel_consumption: null, max_rpm: 1623, average_rpm: 1381, max_throttle_position: 23, average_throttle_position: 17, max_engine_load: 58, average_engine_load: 34, gps_accuracy: 0, speed: 0, longitude: 85.813191, latitude: 20.307191, gps_utc_time: "20190128025435", mileage: 511.5, send_time: 20190128025438, count_number: "AF90", protocol: "+RESP:GTJES", created_date: "2019-02-05T11:43:49.
status_code: 200, trip: { id: "5c557573f3efb259a50b1b8b", imei: "1234567890", total_distance: 0.0, total_time: 120.
engine_rpm: null, vehicle_speed: null, engine_coolant_temp: null, fuel_consuption: null, dtc_cleared_distance: null, mil_activated_distance: null, mil_status: null, number_of_dtc: null, dignostic_trouble_codes: null, throttle_position: null, engine_load: null, fuel_level_input: null, obd_protocol: "6", obd_mileage: "30", gps_accuracy: "0", speed: "3.9", longitude: "85.820893", latitude: "20.358351", gps_utc_time: "00", mileage: "329.0", send_time: "20190202054715", count_number: "179B" }]}}} 46.
record_date_timezone: "08-01-2019"(date-month-year) },........ ] trip_running: true, } 47. Trip Log / List Trip List API which give list of records with it, long and other information. And it also give time travelled and distance travelled API - https://api.amcrestgps.net/api/trips/list///// Method – GET *Example Request API - https://api.amcrestgps.
send_time: "20190105001659", count_number: "9D62" }, { protocol: "+RESP:GTOBD", date: "08/01/2019", time: "17:36:30", protocol_version: "360901", imei: "864251020323808", device_name: null, obd_connection: "1", obd_power_voltage: "14358", supported_pid: "983A8000", engine_rpm: "964", vehicle_speed: "19", engine_coolant_temp: "0", fuel_consuption: "7.
fuel_consuption: "7.5", dtc_cleared_distance: null, mil_activated_distance: null, mil_status: "0", number_of_dtc: "0", dignostic_trouble_codes: null, throttle_position: "13", engine_load: "26", fuel_level_input: null, obd_protocol: "6", obd_mileage: "10", gps_accuracy: "0", speed: "20.5", longitude: "-95.643188", latitude: "29.838755", gps_utc_time: "00", mileage: "165.
mileage: "165.1", send_time: "20190105001959", count_number: "2E59" }, { protocol: "+RESP:GTOBD", date: "08/01/2019", time: "17:36:32", protocol_version: "360901", imei: "864251020323808", device_name: null, obd_connection: "1", obd_power_voltage: "14358", supported_pid: "983A8000", engine_rpm: "964", vehicle_speed: "19", engine_coolant_temp: "0", fuel_consuption: "7.
hour_meter_count: null, mileage: "181.
