Simple procedure to avail Warranty API
1. Choose the slot for demo/ Submit the contact form
Contact us to learn about Warranty APIs pricing plans and payment options. You can also evaluate the best fit for your needs and budget.
2. Register/ Sign Up for the API
Sign up for the warranty price predictor API and obtain an API key that will be used to access the API. We will also provide you with API documentation that outlines how to use the API.
3. Integrate the API
Integrate the API into your ecommerce site by creating API requests that pass in the necessary parameters such as product price and warranty duration. Your site developer can do this using any programming language that supports HTTP requests.
4. Test the API (Staging)
Ensure that the API responses are well-formed, accurate, and contain all the necessary information. Sandbox version helps to handle different response codes and error messages under different scenarios.
5. Test the API (Production)
Under Production version, Ensure that the API is secured against unauthorized access and that sensitive data is transmitted securely over HTTPS.
6. Monitor the API
Continuously monitor the API to ensure that it is functioning correctly and that it is returning accurate warranty price predictions. Make any necessary updates or changes to the API to ensure that it is meeting your needs.
API Documentation
Devices
URI Parameters
-
None
Body
GET https://4biz.bigfix.in/devices/
Content-Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"title": "Devices",
"description": "Give you the list of devices",
"type": "object",
"properties": none,
"required": [
],
"additionalProperties": false,
"headers": {
"Authorization": {
"type": "string",
"minLength": 1,
"description": "Unique key for authentication."
}
}
}
Example:
{
}
Plan Price
URI Parameters
- product: required (string)
- device_price: required (integer)
- plan: required (string)
Body
GET https://4biz.bigfix.in/planprice/
Content-Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"title": "Plan Price",
"description": "Give you the list of available plans and their pricing",
"type": "object",
"properties": none,
"required": [
],
"additionalProperties": false,
"queryParameters": {
"product": {
"id": "product",
"type": "string",
"minLength": 1,
"required": True
},
"device_price": {
"id": "device_price",
"type": "integer",
"minLength": 1,
"required": True
},
"plan": {
"id": "plan",
"type": "string",
"minLength": 1,
"required": True
}
}
"headers": {
"Authorization": {
"type": "string",
"minLength": 1,
"description": "Unique key for authentication."
}
}
}
Example:
{
}
HTTP status code 200
Body
Content-Type: application/json
Example:
{
"status": 200,
"message": "success",
"plans": [
{
"year": 1,
"planpirce": 1716
},
{
"year": 2,
"planpirce": 2496
},
{
"year": 3,
"planpirce": 3034
}
]
}
HTTP status code 400
Body
Content-Type: application/json
Example:
[
{
"status": 400,
"error": "Invalid Payload",
"message": "/ product value is required./"
},
{
"status": 400,
"error": "Invalid Payload",
"message": "/ device_price must be an integer./"
}
]
Generate Policy
URI Parameters
-
None
Body
POST https://4biz.bigfix.in/generatepolicy/
Content-Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"title": "Generate Policy",
"description": "Generates Proposal ID for the plan",
"type": "object",
"properties": {
"product": {
"id": "product",
"type": "string",
"minLength": 1,
"required": True
},
"duration": {
"id": "duration",
"type": "string",
"minLength": 1,
"required": True
},
"device_price": {
"id": "device_price",
"type": "integer",
"minLength": 1,
"required": True
},
"plan": {
"id": "plan",
"type": "string",
"minLength": 1,
"required": True
},
"device_purchase_date": {
"id": "device_purchase_date",
"type": "string",
"minLength": 1,
"required": True
},
"customer_name": {
"id": "customer_name",
"type": "string",
"minLength": 1,
"required": True
},
"customer_phone": {
"id": "customer_phone",
"type": "string",
"minLength": 1,
"required": True
},
"customer_email": {
"id": "customer_email",
"type": "string",
"minLength": 1,
"required": True
},
"customer_address": {
"id": "customer_address",
"type": "string",
"minLength": 1,
"required": True
},
"customer_city": {
"id": "customer_city",
"type": "string",
"minLength": 1,
"required": True
},
"customer_state": {
"id": "customer_state",
"type": "string",
"minLength": 1,
"required": True
},
"customer_pincode": {
"id": "customer_pincode",
"type": "string",
"minLength": 1,
"required": True
},
"manufacturing_duration": {
"id": "manufacturing_duration",
"type": "integer",
"minLength": 1,
"required": True
},
"brand": {
"id": "brand",
"type": "string",
"minLength": 1,
"required": True
},
"model": {
"id": "model",
"type": "string",
"minLength": 1,
"required": True
},
"imei_serial_no": {
"id": "imei_serial_no",
"type": "string",
"minLength": 1,
"required": True
},
"device_purchase_invoice_no": {
"id": "device_purchase_invoice_no",
"type": "string",
"minLength": 1,
"required": True
},
"device_invoice": {
"id": "device_invoice",
"type": "string",
"format": "base64",
"minLength": 1,
"description": "Base64-encoded representation of the file data."
"required": True
},
"device_invoice_name": {
"id": "device_invoice_name",
"type": "string",
"minLength": 1,
"description": "File name of the device_invoice"
"required": True
}
},
"required": [
"product",
"duration",
"device_price",
"plan",
"device_purchase_date",
"customer_name",
"customer_phone",
"customer_email",
"customer_address",
"customer_city",
"customer_state",
"customer_pincode",
"manufacturing_duration",
"brand",
"model",
"imei_serial_no",
"device_purchase_invoice_no",
"device_invoice",
"device_invoice_name"
],
"additionalProperties": false,
"headers": {
"Authorization": {
"type": "string",
"minLength": 1,
"description": "Unique key for authentication."
}
}
}
Example:
{
"product": "Mobile Phone",
"duration": 1,
"device_price": 134999,
"device_purchase_date": "2024-01-17",
"plan": "Extended Warranty",
"customer_name": "Test User",
"customer_phone": "1234567890",
"customer_email": "testuser@mail.com",
"customer_address": "Test User Address",
"customer_city": "Chennai",
"customer_state": "Tamil Nadu",
"customer_pincode": "600106",
"manufacturing_duration": 12,
"brand": "One Plus",
"model": "Open",
"imei_serial_no": "5648374638475629",
"device_purchase_invoice_no": "INVOICENO0001",
"device_invoice": "$%FJEIFkd$hueihaf^$kjeuadkavfg.....",
"device_invoice_name": "invoice.pdf"
}
HTTP status code 200
Body
Content-Type: application/json
Example:
{
"status": 200,
"message": "success",
"proposalid": "BASC1046"
}
HTTP status code 400
Body
Content-Type: application/json
Example:
[
{
"status": 400,
"error": "Invalid Payload",
"message": "/ product is required./"
},
{
"status": 400,
"error": "Invalid Payload",
"message": "/ device_purchase_date should be in YYYY-MM-DD format./"
}
]
Generate Policy - Test
URI Parameters
-
None
Body
POST https://4biz.bigfix.in/generatepolicytest/
Content-Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"title": "Generate Policy",
"description": "Generates Proposal ID for the plan",
"type": "object",
"properties": {
"product": {
"id": "product",
"type": "string",
"minLength": 1,
"required": True
},
"duration": {
"id": "duration",
"type": "string",
"minLength": 1,
"required": True
},
"device_price": {
"id": "device_price",
"type": "integer",
"minLength": 1,
"required": True
},
"plan": {
"id": "plan",
"type": "string",
"minLength": 1,
"required": True
},
"device_purchase_date": {
"id": "device_purchase_date",
"type": "string",
"minLength": 1,
"required": True
},
"customer_name": {
"id": "customer_name",
"type": "string",
"minLength": 1,
"required": True
},
"customer_phone": {
"id": "customer_phone",
"type": "string",
"minLength": 1,
"required": True
},
"customer_email": {
"id": "customer_email",
"type": "string",
"minLength": 1,
"required": True
},
"customer_address": {
"id": "customer_address",
"type": "string",
"minLength": 1,
"required": True
},
"customer_city": {
"id": "customer_city",
"type": "string",
"minLength": 1,
"required": True
},
"customer_state": {
"id": "customer_state",
"type": "string",
"minLength": 1,
"required": True
},
"customer_pincode": {
"id": "customer_pincode",
"type": "string",
"minLength": 1,
"required": True
},
"manufacturing_duration": {
"id": "manufacturing_duration",
"type": "integer",
"minLength": 1,
"required": True
},
"brand": {
"id": "brand",
"type": "string",
"minLength": 1,
"required": True
},
"model": {
"id": "model",
"type": "string",
"minLength": 1,
"required": True
},
"imei_serial_no": {
"id": "imei_serial_no",
"type": "string",
"minLength": 1,
"required": True
},
"device_purchase_invoice_no": {
"id": "device_purchase_invoice_no",
"type": "string",
"minLength": 1,
"required": True
},
"device_invoice": {
"id": "device_invoice",
"type": "string",
"format": "base64",
"minLength": 1,
"description": "Base64-encoded representation of the file data."
"required": True
},
"device_invoice_name": {
"id": "device_invoice_name",
"type": "string",
"minLength": 1,
"description": "File name of the device_invoice"
"required": True
}
},
"required": [
"product",
"duration",
"device_price",
"plan",
"device_purchase_date",
"customer_name",
"customer_phone",
"customer_email",
"customer_address",
"customer_city",
"customer_state",
"customer_pincode",
"manufacturing_duration",
"brand",
"model",
"imei_serial_no",
"device_purchase_invoice_no",
"device_invoice",
"device_invoice_name"
],
"additionalProperties": false,
"headers": {
"Authorization": {
"type": "string",
"minLength": 1,
"description": "Unique key for authentication."
}
}
}
Example:
{
"product": "Mobile Phone",
"duration": 1,
"device_price": 134999,
"device_purchase_date": "2024-01-17",
"plan": "Extended Warranty",
"customer_name": "Test User",
"customer_phone": "1234567890",
"customer_email": "testuser@mail.com",
"customer_address": "Test User Address",
"customer_city": "Chennai",
"customer_state": "Tamil Nadu",
"customer_pincode": "600106",
"manufacturing_duration": 12,
"brand": "One Plus",
"model": "Open",
"imei_serial_no": "5648374638475629",
"device_purchase_invoice_no": "INVOICENO0001",
"device_invoice": "$%FJEIFkd$hueihaf^$kjeuadkavfg.....",
"device_invoice_name": "invoice.pdf"
}
HTTP status code 200
Body
Content-Type: application/json
Example:
{
"status": 200,
"message": "success",
"proposalid": "BASC1046"
}
HTTP status code 400
Body
Content-Type: application/json
Example:
[
{
"status": 400,
"error": "Invalid Payload",
"message": "/ product is required./"
},
{
"status": 400,
"error": "Invalid Payload",
"message": "/ device_purchase_date should be in YYYY-MM-DD format./"
}
]