1. Server: 

API URL:

– production: https://app.home3ds.com/api/partner

– sandbox: https://test.home3ds.com/api/partner

Api key test: please contact us via: [email protected]

1. Product SKUs: 

SKU	Product	Description
2D-FLOOR-PLAN	2D floor plan
3D-FLOOR-PLAN
VIRTUAL-STAGING
VIRTUAL-STAGING-360
VIRTUAL-RENOVATION
VIRTUAL-RENOVATION-360
3D-WALKING-TOURS
IMAGE-ENHANCEMENT

2. Explain and example about api home3ds.

2.1. Create task: (task/create)

Key	Type	Required	Empty value / Note	Note
order_id	string	yes
title	string	yes	‘2D floor plan – Showcase modal’	For 2D-FLOOR-PLAN: Title for option ‘2D floor plan – Showcase modal’ and ‘2D floor plan – Sketch’
order_date	string	yes	format mysql “YYYY-MM-DD hh:mm:ss”
total_price	float	no	”
content	string	yes	-> see detail bellow
items	array	yes	-> see detail bellow

– content: (html code) The content of the order, all data related to the order, e.g. options, image links, need to be formatted as html, to be displayed in the task description.

Convert it to HTML:

<div><strong>Product: </strong>: 2D Floor Plan</div>
<div><strong>Add on</strong>: 2D full color floor plan
2D textured floor plan
2D site plan, 3D Floor Plan, 3D site plan </div>
<div><strong>2D full color floor plan style</strong>: STYLE 2</div>
<div><strong>2D textured floor plan style</strong>: STYLE 4</div>
<div><strong>2D site plan style</strong>: STYLE 11</div>
<div><strong>3D Floor Plan style</strong>: STYLE 02</div>

<div><strong>Language</strong>:English</div>
<div><strong>Address</strong>: 123 street</div>
<div><strong>Project notes</strong>: Note</span></div>

– items: array of object bellow

Key	Type	Required	Empty value / Note
sku	string	yes
title	string	yes
data	object	no	{}

2.2. Account Integration: (integration/update)

Key	Type	Required	Empty value / Note
callback_url	string	yes
callback_authorization_key	string	yes

Callback api url is the path to your api, when Hom3ds completes the order, we will call this api with data about the task ( such as order_id, image links.)

Callback auth key: This is the key that you provide to home3ds. The purpose is to authenticate when we call the api through your system.

2.3. Deliver callback: (receiver_order)

Key	Type	Required	Empty value / Note
order_id	string	yes
sku	string	yes
links	array	yes	array of link address

– links:

[
"https://home3ds.com/deliver_files/1.pdf",
"https://home3ds.com/deliver_files/2.pdf"
]