Dynamo Integration – API Parameters
Following is the recommended API flow for better user experience so that users can see the pricing after each selection set. Initially the price range would be wide, but would get narrower as additional parameters are selected.
All the API’s are mandatory and POST type. Following are the set of API’s:
- Make API
- Car Name API
- Year API
- PricingMCY API - Pricing By Make, Car Name and Year (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
- Color API
- PricingMCYC API - Pricing By Make, Car Name, Year and Color (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
- Mileage API
- PricingMCYCM API - Pricing By Make, Car Name, Year, Color and Mileage (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
- Model API
- PricingMCYCMM API - Pricing By Make, Car Name, Year, Color, Mileage and Model (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
- Grade API
- PricingMCYCMMG API - Pricing By Make, Car Name, Year, Color, Mileage, Model and Grade (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
- Accident Status API
- PricingMCYCMMGA API - Pricing By Make, Car Name, Year, Color, Mileage, Model, Grade and Accident Status (Minimum - Maximum and Average Prices to be displayed on the basis of selected API’s)
Note: Language selection will be based on “English=en” and “Japanese=jp”
- Make API
This API will return all the values available as “Make Name” i-e: Toyota, Suzuki
Endpoint:
POST https://dynamo.hul-hub.com/api/Makes?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language |
|
Input JSON |
Output JSON |
|
{ "language" : "en" } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "makeId": 1, "makeName": "DAIHATSU" }, { "makeId": 17, "makeName": "LAND ROVER" } ] } |
- Car Name API
This API will return all the values available as “Car Name”. Therefore the list of Car Names will be displayed against pre-selected Make API i-e: Corolla, Vitz, Land Cruiser.
Endpoint:
POST https://dynamo.hul-hub.com/api/CarNames?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 2 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "carId": 151, "carName": "ACCORD" }, { "carId": 150, "carName": "ACCORD COUPE" } ] } |
- Year API
This API will return all the values available as “Year ID”. Therefore list of Year ID’s will be displayed against pre-selected Make, Car Name API i-e: 2015, 2018, 2020.
Endpoint:
POST https://dynamo.hul-hub.com/api/Years?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id From CarName API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "yearId": 2021, "yearName": 2021 }, { "yearId": 2020, "yearName": 2020 } ] } |
- PricingMCY API
This API will return “Pricing Value” based on the results of all selected Make, Car Name and Year i-e: min: 3000, avg: 6000, max: 9000.
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCY?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters :
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": "381391.3542", "maxPrice": 1897000 } ] } |
- Color API
This API will return all the values available as “Color Name”. Therefore list of Colors will get displayed against pre-selected Make, CarName and Year API
Note: Make, CarName, Year will push the Color API. Where Model and Grade are optional for selection. If above all API’s are selected then Color will be fetched on the basis of those API’s i-e: White, Yellow, Red.
Endpoint:
POST https://dynamo.hul-hub.com/api/Colors?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "colorId": 1, "colorName": "beige" }, { "colorId": 2, "colorName": "black" } ] } |
- PricingMCYC API
This API will return “Pricing Value” based on the results of all selected Make, Car Name, Year and Color i-e: min: 3000, avg: 6000, max: 9000.
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCYC?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters :
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": "381391.3542", "maxPrice": 1897000 } ] } |
- Mileage API
This API will return all the values available as “Mileage Id”.
i-e: 20000- 40000, 50000-60000
Endpoint:
POST https://dynamo.hul-hub.com/api/Mileages?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
Input JSON |
Output JSON |
|
{ "language" : "en" } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "mileageId": 1, "mileageRange": "0 - 10000" }, { "mileageId": 2, "mileageRange": "10001 - 20000" }, { "mileageId": 3, "mileageRange": "20001 - 30000" } ] } |
- PricingMCYCM API
This API will return “Pricing Value” based on the results of all selected Make, Car Name, Year, Color and Mileage.
i-e: min: 3000, avg: 6000, max: 9000
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCYCM?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters :
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" :1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": “381391.35”, "maxPrice": 1897000 } ] } |
- Model API
This API will return all the values available as “Model Name”. Therefore the list of Models will be displayed against pre-selected Make, CarName, Year, Color and Mileage API i-e: GYA980, DSX887.
Endpoint:
POST https://dynamo.hul-hub.com/api/Models?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id From CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "modelId": 1, "modelName": "L375S" }, { "modelId": 126, "modelName": "LA600S" } ] } |
- PricingMCYCMM API
This API will return “Pricing Value” based on the results of all selected Make, Car Name, Year, Color, Mileage and Model. i-e: min: 3000, avg: 6000, max: 9000.
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCYCMM?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters :
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
7 |
modelId |
int |
* |
Model Id from Model API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" :1, "modelId" : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": “381391.35”, "maxPrice": 1897000 } ] } |
- Grade API
This API will return all the values available as “Grade Name”. Therefore the list of Grades will be displayed against pre-selected Make, CarName, Year, Color, Mileage and Model API i-e: CUSTOM X LIMITED.
Endpoint:
POST https://dynamo.hul-hub.com/api/Grades?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id From CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
7 |
modelId |
int |
* |
Model Id from Model API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" : 1, "modelId": 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "gradeId": "1", "gradeName": "SLOPER REAR SEATS EXIST" }, ] } |
- PricingMCYCMMG API
This API will return “Pricing Value” based on the results of all selected Make, Car Name, Year, Color, Mileage, Model and Grade.
i-e: min: 3000, avg: 6000, max: 9000
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCYCMMG?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters :
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
7 |
modelId |
int |
* |
Model Id from Model API |
|
8 |
gradeId |
int |
* |
Grade Id from Grade API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" :1, "modelId" : 1, "gradeId" : “1” } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": 381391.35, "maxPrice": 1897000 } ] } |
- Accident Status
This API will return all the values available as “Accident Status Id”.
i-e: For Accidental Cars (O, A, R, RA) grades will be fetched
For Non Accidental Cars (1, 2, 3 ... ) grades will be fetched
Endpoint:
POST https://dynamo.hul-hub.com/api/AccidentStatuses?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
Input JSON |
Output JSON |
|
{ "language" : "en" } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "accidentId": 0, "accidentStatus": "No" }, { "accidentId": 1, "accidentStatus": "Yes" } ] } |
- PricingMCYCMMGA API
This API will return “Pricing Value” based on the results of all selected Make, Car Name, Year, Color, Mileage, Model, Grade and Accident Status. i-e: min: 3000, avg: 6000, max: 9000.
Endpoint:
POST https://dynamo.hul-hub.com/api/PricingMCYCMMGA?code={CODE}
{CODE} => API authentication token (generated by service provider and available via web portal)
Headers:
|
Key |
Value |
Description |
|
X-Api-Key |
API License Key Generated from Web Portal |
Monthly usage will be tracked for each license key |
Input Parameters:
|
Parameter No |
Item Name |
Type |
Req |
Description |
|
1 |
language |
string |
* |
Language Id |
|
2 |
makeId |
int |
* |
Make Id from Make API |
|
3 |
carId |
int |
* |
Car Id from CarName API |
|
4 |
yearId |
int |
* |
Year Id from Year API |
|
5 |
colorId |
int |
* |
Color Id from Color API |
|
6 |
mileageId |
int |
* |
Mileage Id from Mileage API |
|
7 |
modelId |
int |
* |
Model Id from Model API |
|
8 |
gradeId |
int |
* |
Grade Id from Grade API |
|
9 |
accidentStatusId |
int |
* |
Accident Status Id from Accident Status API |
|
Input JSON |
Output JSON |
|
{ "language" : "en", "makeId" : 1, "carId" : 6, "yearId" : 1, "colorId" : 1, "mileageId" :1, "modelId" : 1, "gradeId" : “1”, “accidentStatusId” : 1 } |
{ "id": 0, "statusCode": 200, "message": "Success", "errors": null, "data": [ { "minPrice": 1000, "avgPrice": 381391.3542, "maxPrice": 1897000 } ] } |
Error Messages for all API’s
Error Codes:
Status Code : 400 -> Bad Request
Status Code : 401 -> Unauthorized
Status Code : 403 -> Package Expired (Renew your package )
Status Code : 404 -> Not Found
Status Code : 422 -> Unable to process request / Error
Status Code : 429 -> Quota Exceeded
Status Code : 500 -> Internal Server Error
|
Case 1 - Description |
Output |
|
If Calling method is wrong |
Status code 404 (Not found) |
|
Case 2 - Description |
Output |
|
If Subscription has expired |
{ "id": 0, "statusCode": 403, "message": "Package Expired", "errors": ["Your subscription has expired, kindly renew your package"], "data": null } |
|
Case 3 - Description |
Output |
|
If API quota is exceeded |
{ "id": 0, "statusCode": 429, "message": "Quota Exceeded", "errors": ["Your subscribed API usage has been exceeded"], "data": null } |
|
Case 4 - Description |
Output |
|
if API License key is not valid |
{ "id": 0, "statusCode": 401, "message": "Invalid Key", "errors": ["User is inactive Or invalid key"], "data": null } |
|
Case 5 - Description |
Output |
|
if API authentication token is not valid |
Status code 401 (Unauthorized) |
|
Case 6 - Description |
Output |
|
If any parameter is missing |
{ "id": 0, "statusCode": 400, "message": "Bad Request", "errors": ["The parameter [x] is required"], "data": null } |
While [x] refers to selected input API parameter
|
Case 7 - Description |
Output |
|
If no data exists for given inputs |
{ "statusCode": 422, "message": "No data found", "data": null } |