Welcome to My Auto Care API Documentation
This documentation contains information about the API calls, tasks and examples.
Feel free to contact us regarding any questions you can't find the answer to at: support@myautocare.co.za
Client Guide Link: Client Guide
Admin Guide Link: Admin Guide
1. Introduction
1.1. General Formatting
{
"api_token": "your_api_token_here",
"task": "task_name_here",
"data" : {
// Task-specific data here
}
}
1.2. Tasks
Add Multiple Users
"task": "saveMultipleUserChery"
Get Users Information
"task": "getUserDetailsChery
Set Service/Claim
"task": "setServicesChery"
2. Add Multiple User
2.1. Overview
Interface for adding multiple users, and updating existing ones if the information is already at the endpoint. The operation will return a json file, inside there'll be an excel file with a link to download the logs. The created excel file will overwrite the old one after each API call.
2.2. Rules
Object must have all keys, but if the value is optional then empty string must be sent!
- userInfo
- users_name
- users_za_id
- users_mail
- phones_number
- vehicleInfo
- vehicles_Make
- vehicles_Model
- vehicles_Model_Generation
- vehicles_Model_Code
- vehicles_Engine_code
- vehicles_registry
- vehicles_VIN
- vehicles_Color
User info must be validated successfully in order to continue.
Recommended.
Maximum 50 characters.
Required.
13 characters.
Either email or phone is required.
Accepted format: [email protected]
Either email or phone is required.
Accepted format: 123456789 (9 characters, without “0” and no country code).
Vehicle registry, make and model is required. otherwise API will skip adding vehicle.
Maximum 50 characters.
Maximum 50 characters.
Maximum 50 characters.
Maximum 50 characters.
Maximum 50 characters.
Required to save users vehicle.
Required to save users vehicle.
17 characters.
2.3. Examples
Request
{
"api_token": "your_api_token_here",
"task": "saveMultipleUserChery",
"data": {
"users": [
{
"userInfo": {
"users_name": "Jack Sparrow",
"users_za_id": "1231564615555",
"users_mail": "[email protected]",
"phones_number": "089 648 2562"
},
"vehicleInfo": {
"vehicles_Make": "ALFA ROMEO",
"vehicles_Model": "4C",
"vehicles_Model_Generation": "2013",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "36 AD 8756",
"vehicles_Engine_code": "960A1000",
"vehicles_VIN": "1234567981234560"
}
},
{
"userInfo": {
"users_name": "Mikolog Miko",
"users_za_id": "1235646236549",
"users_mail": "[email protected]",
"phones_number": "058 526 8545"
},
"vehicleInfo": {
"vehicles_Make": "CHEVROLET",
"vehicles_Model": "Impala",
"vehicles_Model_Generation": "2022",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "ADC 854 BRS",
"vehicles_Engine_code": "8552AEE22",
"vehicles_VIN": "1234567954651231"
}
},
{
"userInfo": {
"users_name": "Noel Baba",
"users_za_id": "5554488669922",
"users_mail": "[email protected]",
"phones_number": "063 558 5555"
},
"vehicleInfo": {
"vehicles_Make": "HUMMER",
"vehicles_Model": "H3",
"vehicles_Model_Generation": "2005",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "HUM 255 MER",
"vehicles_Engine_code": "LH8(325CUV8)",
"vehicles_VIN": "3214567981234560"
}
},
{
"userInfo": {
"users_name": "",
"users_za_id": "",
"users_mail": "",
"phones_number": ""
},
"vehicleInfo": {
"vehicles_Make": "",
"vehicles_Model": "",
"vehicles_Model_Generation": "",
"vehicles_Model_Code": "",
"vehicles_Color": "",
"vehicles_registry": "",
"vehicles_Engine_code": "",
"vehicles_VIN": ""
}
}
]
}
}
The system will automatically set the policy information according to task. At the moment the API is only open for CHERY developers. If you are a provider and would like to make API calls, please contact us.
Return Of A Succesful Call
{
"link_to_excel": "https://api.myautocare.test/temp/multiple_user_add/multiple_user_add_logs.xlsx",
"logs": [
{
"data": {
"userInfo": {
"users_name": "Jack Sparrow",
"users_za_id": "1231564615555",
"users_mail": "[email protected]",
"phones_number": "089 648 2562"
},
"vehicleInfo": {
"vehicles_Make": "ALFA ROMEO",
"vehicles_Model": "4C",
"vehicles_Model_Generation": "2013",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "36 AD 8756",
"vehicles_Engine_code": "960A1000",
"vehicles_VIN": "1234567981234560"
},
"policyInfo": {
"provider_name": "Chery",
"policies_name": "Chery 2 Year",
"policy_dealership": "Chery",
"policy_period": "2 Year",
"effective_date": "2024-02-10 09:42:13",
"expiry_date": "2026-02-10 09:42:13",
"signed_type": "Electronic",
"payment_option": "NULL",
"payment_amount": "NULL",
"policies_deal_ref": "NULL"
},
"servicesInfo": {
"concierge": "",
"taxi": "4",
"roadside-assist": "",
"drive-home": "8",
"surface-plan": "8",
"courtesy-car": "2",
"courtesy-car-extra": "999",
"armed-response": "",
"hijack-assist": "",
"legal-solutions": "",
"pothole-assist": "",
"interior": "",
"exterior": ""
}
},
"created": [
{
"userInfo": {
"users_group_id": [
"4 Created"
],
"users_name": [
"Jack Sparrow Created"
],
"users_za_id": [
"1231564615555 Created"
],
"users_mail": [
"[email protected] Created",
"[email protected] Created!"
],
"users_status": [
"published Created"
],
"users_avatar": [
"https://myautocare.test/assets/default-client/images/avatars/avatar-2.svg Created"
],
"users_gender": [
"Female Created"
],
"pass_pasword": [
"9vm5axcp7"
]
},
"policyInfo": {
"user_policy_id": [
105188
],
"users_id": [
"82372 Created!"
],
"provider_id": [
"3 Created!"
],
"policies_id": [
"5 Created!"
],
"provider_name": [
"Chery Created!"
],
"policy_dealership": [
"Chery Created!"
],
"policy_number": [
"CHE0011146 Created!"
],
"vehicles_VIN": [
"1234567981234560 Created!"
],
"policies_name": [
"Chery 2 Year Created!"
],
"policy_period": [
"2 Year Created!"
],
"effective_date": [
"2024-02-10 Created!"
],
"expiry_date": [
"2026-02-10 Created!"
],
"signed_type": [
"Electronic Created!"
],
"payment_option": [
"NULL Created!"
],
"payment_amount": [
"NULL Created!"
],
"policy_status": [
"published Created!"
]
},
"servicesInfo": {
"taxi": [
"Service created with 4 claim limit!"
],
"drive-home": [
"Service created with 8 claim limit!"
],
"surface-plan": [
"Service created with 8 claim limit!"
],
"courtesy-car": [
"Service created with 2 claim limit!"
],
"courtesy-car-extra": [
"Service created with 999 claim limit!"
]
},
"vehicleInfo": {
"vehicles_Make": [
"ALFA ROMEO has been created!"
],
"vehicles_Model": [
"4C has been created!"
],
"vehicles_Model_Generation": [
"2013 has been created!"
],
"vehicles_Model_Code": [
"A12488 has been created!"
],
"vehicles_Engine_code": [
"960A1000 has been created!"
],
"vehicles_registry": [
"36 AD 8756 has been created!"
],
"vehicles_VIN": [
"1234567981234560 has been created!"
],
"vehicles_Color": [
"Blue has been created!"
],
"users_id": [
"82372 has been created!"
]
}
}
],
"errors": [
{
"policyInfo": {
"effective_date": [
"Posted data does not match expectation ((2024-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2024-02-10 09:42:13) 19 != 10) "
],
"expiry_date": [
"Posted data does not match expectation ((2026-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2026-02-10 09:42:13) 19 != 10) "
],
"payment_amount": [
"Posted data does not match expectation ((NULL) string != Numeric) "
],
"policy_status": [
"Posted data does not match expectation ((published) 9 != [\"published\",\"passive\",\"onhold\"]) "
]
},
"vehicleInfo": {
"vehicles_VIN": [
"Posted data does not match expectation ((1234567981234560) 16 != 17) "
]
},
"userInfo": {
"phones_number": [
"089 648 2562 is found on another user! skipping adding phone number."
]
},
"servicesInfo": {
"concierge": [
"Couldnt save service because service doesnt exist in policy."
],
"roadside-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"armed-response": [
"Couldnt save service because service doesnt exist in policy."
],
"hijack-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"legal-solutions": [
"Couldnt save service because service doesnt exist in policy."
],
"pothole-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"interior": [
"Couldnt save service because service doesnt exist in policy."
],
"exterior": [
"Couldnt save service because service doesnt exist in policy."
]
}
}
]
},
{
"data": {
"userInfo": {
"users_name": "Mikolog Miko",
"users_za_id": "1235646236549",
"users_mail": "[email protected]",
"phones_number": "058 526 8545"
},
"vehicleInfo": {
"vehicles_Make": "CHEVROLET",
"vehicles_Model": "Impala",
"vehicles_Model_Generation": "2022",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "ADC 854 BRS",
"vehicles_Engine_code": "8552AEE22",
"vehicles_VIN": "1234567954651231"
},
"policyInfo": {
"provider_name": "Chery",
"policies_name": "Chery 2 Year",
"policy_dealership": "Chery",
"policy_period": "2 Year",
"effective_date": "2024-02-10 09:42:13",
"expiry_date": "2026-02-10 09:42:13",
"signed_type": "Electronic",
"payment_option": "NULL",
"payment_amount": "NULL",
"policies_deal_ref": "NULL"
},
"servicesInfo": {
"concierge": "",
"taxi": "4",
"roadside-assist": "",
"drive-home": "8",
"surface-plan": "8",
"courtesy-car": "2",
"courtesy-car-extra": "999",
"armed-response": "",
"hijack-assist": "",
"legal-solutions": "",
"pothole-assist": "",
"interior": "",
"exterior": ""
}
},
"created": [
{
"userInfo": {
"users_group_id": [
"4 Created"
],
"users_name": [
"Mikolog Miko Created"
],
"users_za_id": [
"1235646236549 Created"
],
"users_mail": [
"[email protected] Created",
"[email protected] Created!"
],
"users_status": [
"published Created"
],
"users_avatar": [
"https://myautocare.test/assets/default-client/images/avatars/avatar-1.svg Created"
],
"users_gender": [
"Male Created"
],
"pass_pasword": [
"gjkp6qymt"
]
},
"policyInfo": {
"user_policy_id": [
105189
],
"users_id": [
"82373 Created!"
],
"provider_id": [
"3 Created!"
],
"policies_id": [
"5 Created!"
],
"provider_name": [
"Chery Created!"
],
"policy_dealership": [
"Chery Created!"
],
"policy_number": [
"CHE0011147 Created!"
],
"vehicles_VIN": [
"1234567954651231 Created!"
],
"policies_name": [
"Chery 2 Year Created!"
],
"policy_period": [
"2 Year Created!"
],
"effective_date": [
"2024-02-10 Created!"
],
"expiry_date": [
"2026-02-10 Created!"
],
"signed_type": [
"Electronic Created!"
],
"payment_option": [
"NULL Created!"
],
"payment_amount": [
"NULL Created!"
],
"policy_status": [
"published Created!"
]
},
"servicesInfo": {
"taxi": [
"Service created with 4 claim limit!"
],
"drive-home": [
"Service created with 8 claim limit!"
],
"surface-plan": [
"Service created with 8 claim limit!"
],
"courtesy-car": [
"Service created with 2 claim limit!"
],
"courtesy-car-extra": [
"Service created with 999 claim limit!"
]
},
"vehicleInfo": {
"vehicles_Make": [
"CHEVROLET has been created!"
],
"vehicles_Model": [
"Impala has been created!"
],
"vehicles_Model_Generation": [
"2022 has been created!"
],
"vehicles_Model_Code": [
"A12488 has been created!"
],
"vehicles_Engine_code": [
"8552AEE22 has been created!"
],
"vehicles_registry": [
"ADC 854 BRS has been created!"
],
"vehicles_VIN": [
"1234567954651231 has been created!"
],
"vehicles_Color": [
"Blue has been created!"
],
"users_id": [
"82373 has been created!"
]
}
}
],
"errors": [
{
"policyInfo": {
"effective_date": [
"Posted data does not match expectation ((2024-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2024-02-10 09:42:13) 19 != 10) "
],
"expiry_date": [
"Posted data does not match expectation ((2026-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2026-02-10 09:42:13) 19 != 10) "
],
"payment_amount": [
"Posted data does not match expectation ((NULL) string != Numeric) "
],
"policy_status": [
"Posted data does not match expectation ((published) 9 != [\"published\",\"passive\",\"onhold\"]) "
]
},
"vehicleInfo": {
"vehicles_registry": [
"Posted data does not match expectation ((ADC 854 BRS) 11 != 10) "
],
"vehicles_VIN": [
"Posted data does not match expectation ((1234567954651231) 16 != 17) "
]
},
"userInfo": {
"phones_number": [
"058 526 8545 is found on another user! skipping adding phone number."
]
},
"servicesInfo": {
"concierge": [
"Couldnt save service because service doesnt exist in policy."
],
"roadside-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"armed-response": [
"Couldnt save service because service doesnt exist in policy."
],
"hijack-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"legal-solutions": [
"Couldnt save service because service doesnt exist in policy."
],
"pothole-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"interior": [
"Couldnt save service because service doesnt exist in policy."
],
"exterior": [
"Couldnt save service because service doesnt exist in policy."
]
}
}
]
},
{
"data": {
"userInfo": {
"users_name": "Noel Baba",
"users_za_id": "5554488669922",
"users_mail": "[email protected]",
"phones_number": "063 558 5555"
},
"vehicleInfo": {
"vehicles_Make": "HUMMER",
"vehicles_Model": "H3",
"vehicles_Model_Generation": "2005",
"vehicles_Model_Code": "A12488",
"vehicles_Color": "Blue",
"vehicles_registry": "HUM 255 MER",
"vehicles_Engine_code": "LH8(325CUV8)",
"vehicles_VIN": "3214567981234560"
},
"policyInfo": {
"provider_name": "Chery",
"policies_name": "Chery 2 Year",
"policy_dealership": "Chery",
"policy_period": "2 Year",
"effective_date": "2024-02-10 09:42:13",
"expiry_date": "2026-02-10 09:42:13",
"signed_type": "Electronic",
"payment_option": "NULL",
"payment_amount": "NULL",
"policies_deal_ref": "NULL"
},
"servicesInfo": {
"concierge": "",
"taxi": "4",
"roadside-assist": "",
"drive-home": "8",
"surface-plan": "8",
"courtesy-car": "2",
"courtesy-car-extra": "999",
"armed-response": "",
"hijack-assist": "",
"legal-solutions": "",
"pothole-assist": "",
"interior": "",
"exterior": ""
}
},
"created": [
{
"userInfo": {
"users_group_id": [
"4 Created"
],
"users_name": [
"Noel Baba Created"
],
"users_za_id": [
"5554488669922 Created"
],
"users_mail": [
"[email protected] Created",
"[email protected] Created!"
],
"users_status": [
"published Created"
],
"users_avatar": [
"https://myautocare.test/assets/default-client/images/avatars/avatar-1.svg Created"
],
"users_gender": [
"Male Created"
],
"pass_pasword": [
"wxq1bvsmn"
]
},
"policyInfo": {
"user_policy_id": [
105190
],
"users_id": [
"82374 Created!"
],
"provider_id": [
"3 Created!"
],
"policies_id": [
"5 Created!"
],
"provider_name": [
"Chery Created!"
],
"policy_dealership": [
"Chery Created!"
],
"policy_number": [
"CHE0011148 Created!"
],
"vehicles_VIN": [
"3214567981234560 Created!"
],
"policies_name": [
"Chery 2 Year Created!"
],
"policy_period": [
"2 Year Created!"
],
"effective_date": [
"2024-02-10 Created!"
],
"expiry_date": [
"2026-02-10 Created!"
],
"signed_type": [
"Electronic Created!"
],
"payment_option": [
"NULL Created!"
],
"payment_amount": [
"NULL Created!"
],
"policy_status": [
"published Created!"
]
},
"servicesInfo": {
"taxi": [
"Service created with 4 claim limit!"
],
"drive-home": [
"Service created with 8 claim limit!"
],
"surface-plan": [
"Service created with 8 claim limit!"
],
"courtesy-car": [
"Service created with 2 claim limit!"
],
"courtesy-car-extra": [
"Service created with 999 claim limit!"
]
},
"vehicleInfo": {
"vehicles_Make": [
"HUMMER has been created!"
],
"vehicles_Model": [
"H3 has been created!"
],
"vehicles_Model_Generation": [
"2005 has been created!"
],
"vehicles_Model_Code": [
"A12488 has been created!"
],
"vehicles_Engine_code": [
"LH8(325CUV8) has been created!"
],
"vehicles_registry": [
"HUM 255 MER has been created!"
],
"vehicles_VIN": [
"3214567981234560 has been created!"
],
"vehicles_Color": [
"Blue has been created!"
],
"users_id": [
"82374 has been created!"
]
}
}
],
"errors": [
{
"policyInfo": {
"effective_date": [
"Posted data does not match expectation ((2024-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2024-02-10 09:42:13) 19 != 10) "
],
"expiry_date": [
"Posted data does not match expectation ((2026-02-10 09:42:13) string != Date) ",
"Posted data does not match expectation ((2026-02-10 09:42:13) 19 != 10) "
],
"payment_amount": [
"Posted data does not match expectation ((NULL) string != Numeric) "
],
"policy_status": [
"Posted data does not match expectation ((published) 9 != [\"published\",\"passive\",\"onhold\"]) "
]
},
"vehicleInfo": {
"vehicles_registry": [
"Posted data does not match expectation ((HUM 255 MER) 11 != 10) "
],
"vehicles_VIN": [
"Posted data does not match expectation ((3214567981234560) 16 != 17) "
]
},
"userInfo": {
"phones_number": [
"063 558 5555 is found on another user! skipping adding phone number."
]
},
"servicesInfo": {
"concierge": [
"Couldnt save service because service doesnt exist in policy."
],
"roadside-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"armed-response": [
"Couldnt save service because service doesnt exist in policy."
],
"hijack-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"legal-solutions": [
"Couldnt save service because service doesnt exist in policy."
],
"pothole-assist": [
"Couldnt save service because service doesnt exist in policy."
],
"interior": [
"Couldnt save service because service doesnt exist in policy."
],
"exterior": [
"Couldnt save service because service doesnt exist in policy."
]
}
}
]
},
{
"data": {
"userInfo": {
"users_name": "",
"users_za_id": "",
"users_mail": "",
"phones_number": ""
},
"vehicleInfo": {
"vehicles_Make": "",
"vehicles_Model": "",
"vehicles_Model_Generation": "",
"vehicles_Model_Code": "",
"vehicles_Color": "",
"vehicles_registry": "",
"vehicles_Engine_code": "",
"vehicles_VIN": ""
},
"policyInfo": {
"provider_name": "Chery",
"policies_name": "Chery 2 Year",
"policy_dealership": "Chery",
"policy_period": "2 Year",
"effective_date": "2024-02-10 09:42:13",
"expiry_date": "2026-02-10 09:42:13",
"signed_type": "Electronic",
"payment_option": "NULL",
"payment_amount": "NULL",
"policies_deal_ref": "NULL"
},
"servicesInfo": {
"concierge": "",
"taxi": "4",
"roadside-assist": "",
"drive-home": "8",
"surface-plan": "8",
"courtesy-car": "2",
"courtesy-car-extra": "999",
"armed-response": "",
"hijack-assist": "",
"legal-solutions": "",
"pothole-assist": "",
"interior": "",
"exterior": ""
}
},
"skipped": [
"3 Indexed Data skipped due fatal errors!"
]
}
],
"memory": "3.45MB",
"status": "success",
"status_code": 200,
"text": "Data added!",
"timerend": "0.3101"
}
At the top of the return there is a link to an extended and detailed excel file. Please download the file to get the detailed logs. This file is a temporary file, and will be overwritten with the next API call!
3. Get Users Information
3.1. Overview
Interface for getting users details from the endpoint, a succesful query will return the users information and all policies that the user has.
3.2. Rules
The only expected data is a key/value pair of users South African identification number.
{
"api_token": "your_api_token_here",
"task": "getUserDetailsChery",
"data" : {
"users_za_id": "12345678912"
}
}
3.3. Examples
Return Of A Successful Call
{
"memory": "2.84MB",
"status": "success",
"status_code": 200,
"timerend": "0.2943",
"users_detail": {
"user": {
"users_id": 82372,
"users_name": "Jack Sparrow",
"users_mail": "[email protected]",
"users_za_id": 1231564615555,
"users_gender": "Female",
"provider_ids": null,
"users_avatar": "https://myautocare.test/assets/default-client/images/avatars/avatar-2.svg",
"users_status": "published",
"address": [],
"contact": {
"phones": [],
"emails": [
{
"email_id": 45038,
"users_id": 82372,
"email_address": "[email protected]",
"email_default": 1,
"email_status": "published",
"email_valid": 0,
"email_validation": "cc519104de92f962c6d0bf62a2f3d5ca",
"created_at": "2024-02-10 09:42:13",
"updated_at": null
}
]
},
"usr_services": [
{
"services_id": 279857,
"users_id": 82372,
"services_tag": "courtesy-car",
"policies_tag": "chery-2-year",
"services_piece": 2,
"provider_id": 3,
"policies_id": 5,
"user_policy_id": 105188,
"created_at": "2024-02-10 09:42:13",
"updated_at": null
},
{
"services_id": 279858,
"users_id": 82372,
"services_tag": "courtesy-car-extra",
"policies_tag": "chery-2-year",
"services_piece": 999,
"provider_id": 3,
"policies_id": 5,
"user_policy_id": 105188,
"created_at": "2024-02-10 09:42:13",
"updated_at": null
},
{
"services_id": 279855,
"users_id": 82372,
"services_tag": "drive-home",
"policies_tag": "chery-2-year",
"services_piece": 8,
"provider_id": 3,
"policies_id": 5,
"user_policy_id": 105188,
"created_at": "2024-02-10 09:42:13",
"updated_at": null
},
{
"services_id": 279856,
"users_id": 82372,
"services_tag": "surface-plan",
"policies_tag": "chery-2-year",
"services_piece": 8,
"provider_id": 3,
"policies_id": 5,
"user_policy_id": 105188,
"created_at": "2024-02-10 09:42:13",
"updated_at": null
},
{
"services_id": 279854,
"users_id": 82372,
"services_tag": "taxi",
"policies_tag": "chery-2-year",
"services_piece": 4,
"provider_id": 3,
"policies_id": 5,
"user_policy_id": 105188,
"created_at": "2024-02-10 09:42:13",
"updated_at": null
}
],
"usr_policies": [
{
"user_policy_id": 105188,
"users_id": 82372,
"provider_id": 3,
"provider_name": "Chery",
"policies_name": "Chery 2 Year",
"policies_id": 5,
"policy_number": "CHE0011146",
"policies_deal_ref": null,
"vehicles_VIN": 1234567981234560,
"effective_date": "2024-02-10 00:00:00",
"expiry_date": "2026-02-10 00:00:00",
"payment_option": null,
"policy_dealership": "Chery",
"payment_amount": null,
"policy_status": "published",
"policy_period": "2 Year",
"signed_type": "Electronic",
"created_at": "2024-02-10 09:42:13",
"updated_at": null
}
],
"chery_2_year": [
{
"policies_id": 5,
"provider_id": 3,
"policies_name": "CHERY 2 YEAR",
"policies_detail": {
"surface-plan": {
"title": "SURFACE PLAN",
"rules": {
"count": "1",
"ruleDays": "90"
},
"subData": {
"scratch-repair": {
"policies_items_id": "26",
"title": "SCRATCH REPAIR",
"rules": {
"count": "1",
"ruleDays": "365"
}
},
"tar-removal": {
"policies_items_id": "54",
"title": "TAR REMOVAL",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"headlight-renewal": {
"policies_items_id": "55",
"title": "HEADLIGHT RENEWAL",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"mag-wheel-repair": {
"policies_items_id": "56",
"title": "MAG WHEEL REPAIR",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"wheel-alignment": {
"policies_items_id": "57",
"title": "WHEEL ALIGNMENT",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"steering-wheel-and-bollard-and-handbrake-and-gear-knob-refreshment": {
"policies_items_id": "58",
"title": "STEERING WHEEL AND BOLLARD AND HANDBRAKE AND GEAR KNOB REFRESHMENT",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"paintless-dent-removal": {
"policies_items_id": "27",
"title": "PAINTLESS DENT REMOVAL (PDR)",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"stone-chip-repair": {
"policies_items_id": "25",
"title": "STONE CHIP REPAIR",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"windscreen-chip-and-crack-repair": {
"policies_items_id": "28",
"title": "WINDSCREEN CHIP AND CRACK REPAIR",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"odor-removal": {
"policies_items_id": "59",
"title": "ODOR REMOVAL",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"leather-or-fabric-treatment": {
"policies_items_id": "60",
"title": "LEATHER OR FABRIC TREATMENT",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
},
"drive-home": {
"title": "DRIVE HOME",
"rules": {
"count": "4",
"ruleDays": "365"
},
"subData": {
"start-date": {
"policies_items_id": "52",
"title": "START DATE",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"start-time": {
"policies_items_id": "53",
"title": "START TIME",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-from": {
"policies_items_id": "50",
"title": "ADDRESS FROM",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-to": {
"policies_items_id": "51",
"title": "ADDRESS TO",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
},
"taxi": {
"title": "TAXI",
"rules": {
"count": "2",
"ruleDays": "365"
},
"subData": {
"start-date": {
"policies_items_id": "52",
"title": "START DATE",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"start-time": {
"policies_items_id": "53",
"title": "START TIME",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-from": {
"policies_items_id": "50",
"title": "ADDRESS FROM",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-to": {
"policies_items_id": "51",
"title": "ADDRESS TO",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
},
"courtesy-car": {
"title": "COURTESY CAR",
"rules": {
"count": "1",
"ruleDays": "365"
},
"subData": {
"car-collection": {
"policies_items_id": "61",
"title": "CAR COLLECTION",
"rules": {
"count": "0",
"ruleDays": "0"
},
"subData": {
"other": {
"policies_items_id": "20",
"title": "OTHER (PLEASE SPECIFY)",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
},
"car-delivery": {
"policies_items_id": "62",
"title": "CAR DELIVERY",
"rules": {
"count": "0",
"ruleDays": "0"
},
"subData": {
"start-date": {
"policies_items_id": "52",
"title": "START DATE",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"start-time": {
"policies_items_id": "53",
"title": "START TIME",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-to": {
"policies_items_id": "51",
"title": "ADDRESS TO",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
}
}
},
"courtesy-car-extra": {
"title": "COURTESY CAR-EXTRA",
"rules": {
"count": "0",
"ruleDays": "0"
},
"subData": {
"car-collection": {
"policies_items_id": "61",
"title": "CAR COLLECTION",
"rules": {
"count": "0",
"ruleDays": "0"
},
"subData": {
"other": {
"policies_items_id": "20",
"title": "OTHER (PLEASE SPECIFY)",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
},
"car-delivery": {
"policies_items_id": "62",
"title": "CAR DELIVERY",
"rules": {
"count": "0",
"ruleDays": "0"
},
"subData": {
"start-date": {
"policies_items_id": "52",
"title": "START DATE",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"start-time": {
"policies_items_id": "53",
"title": "START TIME",
"rules": {
"count": "0",
"ruleDays": "0"
}
},
"address-to": {
"policies_items_id": "51",
"title": "ADDRESS TO",
"rules": {
"count": "0",
"ruleDays": "0"
}
}
}
}
}
}
},
"policies_status": "published",
"policies_prefix": "CHE",
"created_at": "2023-08-27 13:40:07",
"updated_at": "2024-02-05 08:10:03"
}
]
}
}
}
4. Get Users Claim History
4.1. Overview
Interface for getting a specific users claim history, this section requires only the users_id.
4.2. Rules
The only expected key/value pair is the "users_id": "value". The users_id can be retrieved by using the Get Users Information endpoint.
{
"api_token": "your_api_token_here",
"task": "getUserClaimHistoryChery",
"data" : {
"users_id": "1"
}
}
4.3. Examples
Return Of A Succesful Call
{
"data": [
{
"services_id": 9,
"users_id": 1,
"policies_id": 7,
"provider_id": 3,
"accepted_id": 1,
"services_tag": "drive-home",
"services_reference_number": "CCHE0000009",
"policies_tag": "chery-5-year",
"locations_info": {
"latitude": "",
"longitude": ""
},
"services_detail": {
"start_date": "2024-01-24",
"from_address": "46c Gibson Drive East, Buccleuch, Sandton, South Africa",
"to_address": "Primo Executive Cars, Van Riebeeck Avenue, Edenvale, Johannesburg, South Africa",
"additional_information": "TEST",
"from_latitude": "-26.0564146",
"from_longitude": "28.1166083",
"to_latitude": "-26.1329404",
"to_longitude": "28.1484996",
"admin_informations": "TESTING",
"admin": true,
"admin_uploads": [
"https://myautocare.co.za/temp/claim/admin_uploads/1-1706092468.jpg"
]
},
"services_status": "processing",
"services_notice": "",
"created_at": "2024-01-24 12:34:34",
"updated_at": "2024-01-24 12:38:52"
},
{
"services_id": 10,
"users_id": 1,
"policies_id": 7,
"provider_id": 3,
"accepted_id": 1321,
"services_tag": "taxi",
"services_reference_number": "CCHE0000010",
"policies_tag": "chery-5-year",
"locations_info": {
"latitude": "",
"longitude": ""
},
"services_detail": {
"start_date": "2024-01-02",
"from_address": "Greenstone Shopping Centre, Modderfontein, Lethabong, South Africa",
"to_address": "Monte Cassino, Cassino, Province of Frosinone, Italy",
"additional_information": "",
"from_latitude": "-26.1187425",
"from_longitude": "28.1418975",
"to_latitude": "41.49161939999999",
"to_longitude": "13.8158578",
"admin_informations": "test",
"admin": true
},
"services_status": "finish",
"services_notice": null,
"created_at": "2024-01-24 14:10:26",
"updated_at": "2024-01-24 14:11:35"
},
{
"services_id": 11,
"users_id": 1,
"policies_id": 7,
"provider_id": 3,
"accepted_id": 9,
"services_tag": "taxi",
"services_reference_number": "CCHE0000011",
"policies_tag": "chery-5-year",
"locations_info": {
"latitude": "-26.1322273",
"longitude": "28.1475896"
},
"services_detail": {
"start_date": "24/01/2024 16:00",
"from_address": "131 Van Riebeeck Ave, Edenvale, 1609, South Africa",
"from_latitude": "-26.1329404",
"from_longitude": "28.1484996",
"to_address": "202 Madiba St, Pretoria Central, Pretoria, 0002, South Africa",
"to_latitude": "-25.7447286",
"to_longitude": "28.1880929",
"accept_terms": "1",
"accept_sla": "1",
"distance_inbetween": 50.366
},
"services_status": "Canceled",
"services_notice": "test",
"created_at": "2024-01-24 14:53:56",
"updated_at": "2024-01-25 08:15:23"
},
{
"services_id": 12,
"users_id": 1,
"policies_id": 7,
"provider_id": 3,
"accepted_id": 0,
"services_tag": "taxi",
"services_reference_number": "CCHE0000012",
"policies_tag": "chery-5-year",
"locations_info": {
"latitude": "",
"longitude": ""
},
"services_detail": {
"start_date": "2024-01-10",
"from_address": "Greenstone Shopping Centre, Modderfontein, Lethabong, South Africa",
"to_address": "O.R. Tambo International Airport (JNB) (JNB), Jones Road, Kempton Park, Johannesburg, South Africa",
"additional_information": "",
"from_latitude": "-26.1187425",
"from_longitude": "28.1418975",
"to_latitude": "-26.1371051",
"to_longitude": "28.2416174",
"admin_informations": "Test",
"admin": true
},
"services_status": "processing",
"services_notice": null,
"created_at": "2024-01-25 10:26:50",
"updated_at": "2024-01-25 10:26:50"
},
{
"services_id": 15,
"users_id": 1,
"policies_id": 7,
"provider_id": 3,
"accepted_id": 0,
"services_tag": "taxi",
"services_reference_number": "CCHE0000015",
"policies_tag": "chery-5-year",
"locations_info": {
"latitude": "",
"longitude": ""
},
"services_detail": {
"start_date": "2024-02-02 ",
"from_address": "138 8th Avenue, Edenvale, South Africa",
"to_address": "Greenstone Shopping Centre, Modderfontein, Lethabong, South Africa",
"additional-information": "",
"from_latitude": "-26.1326119",
"from_longitude": "28.1470229",
"to_latitude": "-26.1187425",
"to_longitude": "28.1418975",
"admin_informations": "test",
"admin": true
},
"services_status": "waitingpickup",
"services_notice": null,
"created_at": "2024-02-01 08:32:02",
"updated_at": "2024-02-01 08:32:02"
}
],
"memory": "2.85MB",
"status": "success",
"status_code": 200,
"timerend": "0.0340"
}
5. Set Services/Claim
5.1. Overview
Interface for claiming services of the user, the data section requires the policy and provider info, services details, latitude and longitude info and the users info.
5.2. Rules
- locations_info
- policies_id
- provider_id
- services_detail
Users captured location is optional but strongly advised to be sent in order to have a smooth claim experience for the user.
{
"latitude": "-26.0568811",
"longitude": "28.1170248"
}
Required.
Required.
Required.
The services details must always contains “accept_terms” and “accept_sla” information.
“service-tag”(e.g. “scratch-repair”, “tar-removal”, “wheel alignment” etc.) must match the endpoint keys. These keys will be provided in the “Get Users Information” requests.
The “%_informations” and “%_uploads” are optional.
5.3. Examples
Request For Surface Plan
{
"api_token": "your_api_token_here",
"task": "setServicesChery",
"data": {
"locations_info": {
"latitude": "41.01527732031251",
"longitude": "29.1046720078125"
},
"policies_id": "5",
"provider_id": "3",
"services_detail": {
"mag-wheel-repair": "true",
"mag-wheel-repair_informations": "testting2",
"mag-wheel-repair_uploads": ["https://mycare.myautocare.test/temp/claim/mag-wheel-repair/1-1694766455.csv"],
"accept_terms": "1",
"accept_sla": "1"
},
"services_provider": "chery-2-year",
"services_tag": "surface-plan",
"users_id": 1
}
}
Request For Taxi
{
"api_token": "your_api_token_here",
"task": "setServicesChery",
"data": {
"policies_id": "5",
"provider_id": "3",
"services_tag": "taxi",
"locations_info": {
"latitude": "-26.0568596",
"longitude": "28.1169891"
},
"policies_tag": "chery-2-year",
"services_detail": {
"start_date": "10/02/2024",
"start_time": "12:00", // or you can just give full date instead of giving start_time. e.g. "start_date": "2024-02-10 12:00:00" must be in 'YYYY-mm-dd HH:mm:ss'
"from_address": "92 10th Ave, Edenvale, 1609, South Africa",
"from_latitude": "-26.1382571", // we highly recommend working with google maps api.
"from_longitude": "28.1517125",
"to_address": "131 Van Riebeeck Ave, Edenvale, 1609, South Africa",
"to_latitude": "-26.1329404",
"to_longitude": "28.1484996",
"accept_terms": "1",
"accept_sla": "1",
"distance_inbetween": 1.733 // in km's, can be easily obtained using google maps api.
},
"users_id": 1
}
}
Request For Courtesy Car (collection)
{
"api_token": "your_api_token_here",
"task": "setServicesChery",
"data": {
"policies_id": "5",
"provider_id": "3",
"services_tag": "courtesy-car",
"locations_info": {
"latitude": "-26.0568635",
"longitude": "28.1169997"
},
"policies_tag": "chery-2-year",
"services_detail": {
"other": "true",
"other_informations": "TESTING",
"accept_terms": "1",
"accept_sla": "1"
},
"users_id": 1
}
}
Request For Courtesy Car (delivery)
{
"api_token": "your_api_token_here",
"task": "setServicesChery",
"data": {
"policies_id": "5",
"provider_id": "3",
"services_tag": "courtesy-car",
"locations_info": {
"latitude": "-26.0568454",
"longitude": "28.116952"
},
"policies_tag": "chery-2-year",
"services_detail": {
"start_date": "12/02/2024",
"start_time": "18:00", // or you can just give full date instead of giving start_time. e.g. "start_date": "2024-02-10 12:00:00" must be in 'YYYY-mm-dd HH:mm:ss'
"to_address": "131 Van Riebeeck Ave, Edenvale, 1609, South Africa",
"to_latitude": "-26.1329404", // please consider using google maps api.
"to_longitude": "28.1484996",
"accept_terms": "1",
"accept_sla": "1"
},
"users_id": 1
}
}
6. Error Handling
6.1. Overview
Our API is designed to return straightforward and informative error messages in situations where the request couldn’t be processed. Errors are returned as a JSON object.
When an error occurs, the API will respond with a message that provide additional details about the error. Some error responses include a detail field that further describes the error.
General Error Structure
In case of errors during 'Add Multiple Users', 'Get Users Information', and 'Set Services/Claims' tasks, example error responses are shown in the examples provided above.
For example, consider a case where you're trying to add a user and the required user info is missing.
{
"userInfo": {
"users_name": [
"Posted data does not match expectation, users_name is required"
],
"users_za_id": [
"Posted data does not match expectation, users_za_id is required"
],
"users_mail": [
"Posted data does not match expectation, users_mail is required"
],
"phones_number": [
"Posted data does not match expectation, phones_number is required"
]
},
"phone_number":[
"Posted data does not match expectation, (964 548 2622) string != Integer"
]
}
Please review the sections above on 'Add Multiple Users', 'Get Users Information', 'Set Services/Claims' for specific error scenarios and resolution hints.
Also, if you'd like you can donwload the "link_to_excel" file in the returned JSON to access a more detailed error log.
7. Contact Us
If you have any questions, bugs, issues with the usage of our API, please don't hesitate to contact us at [email protected]