API Document

Details of all APIs is used

General Infomation

Endpoint (Staging)
Endpoint (Production)
Signature (param)	MD5 hash of (api_tokenkey + tracking_number + premium_amount)
api_token_key (Staging)
api_token_key (Production)

API Details

API #1 - Submit SME Delivery

• Purpose: Partner request to create a new insurance for the delivery order from the SME Company.

• Trigger when: Partner receive API which create order from SME Partner

• The delivery order is managed by the unique key is tracking_number

POST

Request Body

Name	Type	Description
tracking_number*	String
product_code*	String	i.e "ahasme"
customer_name*	String
customer_phone*	String
pickup_address*	String
drop_up_address*	String
type_of_goods*	String
cod_amount*	interger
item_value*	interger
premium_amount*	interger
customer_email	String
sender_name	String
sender_phone	String
sender_email	String
recipient_name	String
recipient_phone	String
signature*	String
order_created_time*	timestamp
goods_description*	String
good_quantity*	Interger

200: OK OK

{
  "status": "string",​
  "message": "string",​
  "policy_id": "string"
  "url_certificate": "string"
}

API #2 - insert tracking detail

• Purpose: To track all events of a tracking number e.g: Goods in the warehouse, in delivery, delivery failed, ...... And update the delivery status of the tracking number corresponding to the tracking event.

• Trigger when: Any event which changes the status of the tracking number.

POST

Request Body

Name	Type	Description
tracking_number*	String
delivery_status*	String	created, in_process, in_delivery, success, fail, in_return, returned
tracking_detail*	array
tracking_time*	timestamp
tracking_status	String
contact_phone_number	String
contact_email	String
handler_name	String
end_address	String
start_address	String
tracking_desctiption	String
order_id	String
vehicle_type	String
vehicle_number	String
signature*	String
image_url	String

200: OK OK

{
  "status": "string",​
  "message": "string"
}

API #3 - Cancel SME Delivery Order

• Purpose: Partner requests to cancel the insurance policy for the delivery order

• Trigger when: Customer Service staff from Partner cancels a delivery order

POST

Request Body

Name	Type	Description
tracking_number*	String
policy_id*	String
canceled_by*	String
cancellation_reason*	String
cancellation_time*	String
signature*	String

200: OK OK

{
  "tracking_number": "string",
  "policy_id": "string",
  "canceled_by": "string",
  "cancellation_time": "2022-04-06T06:05:00.528Z",
  "cancellation_reason": "string",
  "signature": "string"
}