API Documentation
Infurnia
Beta
Applications Team, Infurnia
Contents
1. Project Management
a. Getting projects
b. Creating new projects
2. Design Management
a. Getting designs
b. Approving designs
c. Enabling rendering
d. Disabling rendering
e. Generating production outputs
3. User Management
a. Getting users
1. Project Management
Getting Projects
API Endpoint:
https://devsandboxbackend.infurnia.com/api/get_projects
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
designer_id String Designer ID (to get projects owned by designer)
business_unit_id* String Default Business Unit ID of your Org.
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
*data Array List of Projects
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl -X POST 'https://devsandboxbackend.infurnia.com/api/get_projects' -H 'infurnia-email:
[email protected]' -H 'infurnia-store-id: 1555946804115' -H 'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --compressed
Sample Response:
{"response_code":1,"data":[{"id":"5151369404871335115","name":"sample_project","client
_name":"sample_client","client_details":null,"project_details":null,"created_at":"2019-04-23
T09:55:33.000Z","updated_at":"2019-04-23T09:55:33.000Z","deleted_at":null,"store_id":"15
55946804115","project_status_id":null,"reference_project_id":null,"consumer_id":null,"desi
gner_id":2609}],"message":"call success"}
Creating Projects
API Endpoint:
https://devsandboxbackend.infurnia.com/api/create_project
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
name* String Project name
designer_id* String User ID of project owner
client_name String Client Name
order_id String Order ID for project
business_unit_id* String Default Business Unit ID of your Org.
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
*data JSON Details of created Project
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl -X POST 'https://devsandboxbackend.infurnia.com/api/create_project' -H
'infurnia-email: [email protected]' -H 'infurnia-store-id: 1555946804115' -H
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --data
'designer_id=2609&name=sample_project&client_name=sample_client' --compressed
Sample Response:
{"response_code":1,"data":{"id":"5151369404871335115","name":"sample_project","store_i
d":"1555946804115","designer_id":"2609","client_name":"sample_client","updated_at":"20
19-04-23T09:55:33.433Z","created_at":"2019-04-23T09:55:33.433Z"},"message":"call
success"}
2. Design Management
Getting Designs
API Endpoint:
https://devsandboxbackend.infurnia.com/api/get_designs
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
designer_id String Designer ID (to get designs owned by designer)
project_id String Project ID (to get designs in the project)
business_unit_id* String Default Business Unit ID of your Org.
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
*data Array List of Designs
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl --location 'https://devsandboxbackend.infurnia.com/api/get_designs' --header
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --header
'infurnia-email: [email protected]' --header 'infurnia-store-id: 1555946804115' --header
'Content-Type: application/json' --data '{
"project_id": "11613585305622784174",
"business_unit_id": "ec1e8874f8484cfa"
}'
Sample Response:
{"response_code":1,"data":[{"id":"13129531951150078191","name":"sample_design","statu
s":"Designing","additional_properties":null,"serial_number":0,"locked":false,"locking_date":
null,"created_at":"2019-04-23T11:09:35.000Z","updated_at":"2022-04-11T04:14:57.000Z","d
eleted_at":null,"business_unit_id":"ec1e8874f8484cfa","project_id":"116135853056227841
74","user_id":"2602","deleted_by_user_id":null,"display_pic_id":"16841095548497104869","
shard_id":1,"last_activity_time":"2022-04-11T04:14:57.000Z","last_activity_user_id":"2602"}]
,"message":"call success"}
Approving Designs
API Endpoint:
https://devsandboxbackend.infurnia.com/api/grant_design_approval
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_branch_id* String Design branch ID
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl -X POST 'https://devsandboxbackend.infurnia.com/api/grant_design_approval' -H
'infurnia-email: [email protected]' -H 'infurnia-store-id: 1555946804115' -H
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --data
'design_branch_id=11613585305622784174' --compressed
Sample Response:
{"response_code":1,"message":"Done"}
Updating Designs Approval Status
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/design_branch/update_approval
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_branch_id* String Design branch ID
status* String Give either ‘grant’ or ‘revoke’ (Approval Status)
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
data* String ‘OK’ when success
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl --location
'https://devsandboxbackend.infurnia.com/enterprise_api/design_branch/update_approval'
--header 'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --header
'infurnia-email: [email protected]' --header 'infurnia-store-id: 1555946804115' --header
'Content-Type: application/json' --data '{
"design_branch_id": "643a6f7132fb5eba",
"status": "revoke"
}'
Sample Response:
{"response_code":1,"data":"OK","message":"call success"}
Locking / Unlocking Designs
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/design/update_lock
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_id* String Design ID
status* String Give either ‘lock’ or ‘unlock’
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
data* String ‘OK’ when success
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl --location
'https://devsandboxbackend.infurnia.com/enterprise_api/design/update_lock' --header
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --header
'infurnia-email: [email protected]' --header 'infurnia-store-id: 1555946804115' --header
'Content-Type: application/json' --data '{
"design_id": "13129531951150078191",
"status": "lock"
}'
Sample Response:
{"response_code":1,"data":"OK","message":"call success"}
Getting Design Branches
API Endpoint:
https://devsandboxbackend.infurnia.com/api/get_design_branches
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_id String Design ID
user_id Number User ID (optional, for role)
business_unit_id* String Default Business Unit ID of your Org.
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
curl -X POST 'https://devsandboxbackend.infurnia.com/api/get_design_branches' -H
'infurnia-email: [email protected]' -H 'infurnia-store-id: 1555946804115' -H
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --data
'design_id=7362251825521998534&user_id=2602' --compressed
Sample Response:
{"response_code":1,"data":[{"id":"11613585305622784174","name":"master","message":"cl
oned
design","exempt":false,"approved":true,"template_branch":false,"default_template":false,"
public_view_enabled":true,"created_at":"2019-04-24T09:21:16.000Z","updated_at":"2023-0
3-17T05:51:37.000Z","deleted_at":null,”locked”:true,“locking_date”:”2019-04-23T11:09:35.0
00Z”,"design_id":"7362251825521998534","initial_version_id":null,"terminal_version_id":nu
ll,"region_id":1,"role":"write"},{"id":"3d4acf1b5556e61c","name":"master","message":null,"e
xempt":false,"approved":false,"template_branch":false,"default_template":false,"public_vie
w_enabled":true,"created_at":"2021-07-05T18:49:11.000Z",”locked”:true,“locking_date”:”20
19-04-23T11:09:35.000Z”,"updated_at":"2021-07-05T18:49:11.000Z","deleted_at":null,"desi
gn_id":"7362251825521998534","initial_version_id":null,"terminal_version_id":null,"region_
id":1,"role":"write"}],"message":"call success"}
Disabling rendering
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/design_branch/update_rendering_
enabled_status
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_branch_id* String Design Branch ID for which rendering is to be
disabled
status* String Must be ‘disable’
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
message String Success / Failure Message
*valid only for successful calls
Enabling rendering
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/design_branch/update_rendering_
enabled_status
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_branch_id* String Design Branch ID for which rendering is to be
enabled
status* String Must be ‘enable’
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
message String Success / Failure Message
*valid only for successful calls
Generating production outputs
The following API endpoint will trigger production output generation:
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/production_detail/get_output
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
design_branch_id* String Design Branch ID for which outputs are to be
generated
commands* Array of Supported commands are as follows:
strings ● 'GetPricingQuotationDetailsJSON' - Get
pricing quotation in JSON
● 'GetPricingQuotationXlsx' - Get pricing
quotation in XLSX
● 'GetPricingQuotationPdf' - Get pricing
quotation in PDF
● 'GetPricingQuotationCsv' - Get pricing
quotation in CSV
● 'GetCabinetCompositeBoq' - Get cabinet
composite BOQ
● 'GetStandardWoodenRmOutput' - Get
standard wooden RM output
● 'GetStandardHardwareRmOutput' - Get
standard hardware RM output
● 'GetCutlistCsv' - Get cutlist in CSV
● 'GetManufacturingCutlistCsv' - Get
manufacturing cutlist in CSV
● 'GetCurrentBoardTypeCurrentBoard' - Get
current board type current board
● 'GetCurrentBoardTypeAllBoards' - Get
current board type all boards
● 'GetAllBoardTypeAllBoards' - Get all board
type all boards
● 'GetBoardLayoutCount' - Get board layout
count
● 'GetBoardLayoutFinishCount' - Get board
layout finish count
● 'GetFloorplanFloorViews' - Get floor plan
floor views
● 'GetFloorplanRoomViews' - Get floor plan
room views
● 'GetFulfillmentTags' - Get fulfillment tags
● 'GetCNCMachineOutputCix' - Get CNC
machine output CIX
● 'GetCNCMachineOutputMpr' - Get CNC
machine output MPR
● 'GetCNCMachineOutputXcs' - Get CNC
machine output XCS
● 'GetCNCMachineOutputPdf' - Get CNC
machine output PDF
*required fields
Sample Curl:
Curl -X POST
'https://devsandboxbackend.infurnia.com/enterprise_api/production_detail/get_output' -H
'infurnia-email: [email protected]' -H 'infurnia-store-id: 1555946804115' -H
'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' –data
‘'design_branch_id=76b5aecefed82a2e&commands=["GetPricingQuotationDetailsJSON"]’
--compressed
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
data JSON This will have `request_batch_id`, which will have to
be used to poll for the output generation status
*valid only for successful calls
Sample Response:
{"response_code":1,"data":{"request_batch_id":"5e8f548d80ab1c08"},"message":"call
success"}
The following endpoint must be used to poll and obtain the progress of output generation:
API Endpoint:
https://devsandboxbackend.infurnia.com/enterprise_api/production_detail/get_status
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
Request Data:
Field Name Type Description
ids Array `request_batch_id` for which status is to be checked
*required fields
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
data JSON This will have `status` and `output_file_path`
*valid only for successful calls
3. User Management
Getting Users
API Endpoint:
https://devsandboxbackend.infurnia.com/api/get_all_users
Request Headers:
Field Name Type Description
infurnia-access-token String API access token
infurnia-email String Email with permission to use APIs
infurnia-store-id String Store ID (with permission to use APIs)
business_unit_id* String Default Business Unit ID of your Org.
Response Data:
Field Name Type Description
response_code Number Indicator variable. Equals 1 for success & -1 for
failure
*data Array List of Users
message String Success / Failure Message
*valid only for successful calls
Sample Curl:
Curl -X POST 'https://devsandboxbackend.infurnia.com/api/get_all_users' -H 'infurnia-email:
[email protected]' -H 'infurnia-store-id: 1555946804115' -H 'infurnia-access-token:
$2a$08$dzPEEBlrqq20dbY8lxNKsOPZkTq0YmyRODdQI.7iZU.XtrV2UoJUK' --compressed
Sample Response:
{"response_code":1,"data":[{"id":2602,"type":"business","first_name":"","last_name":"","con
tact":null,"orphan":null,"allow_store_plugin_usage":true,"allow_store_design_usage":true,"
onboarding_prompt":null,"onboarding_project_prompt":null,"deprecated":false,"created_a
t":"2019-04-22T15:26:44.000Z","updated_at":"2023-03-06T08:06:56.000Z","deleted_at":null
,"store_id":"1555946804115","login_id":"18278353894987196153","display_pic_id":null,"act
ive_designer_user_role_id":"14090843531555790923","region_id":1,"login":{"id":"18278353
894987196153","default_user_id":2602,"email":"[email protected]","username":null,"o
rphan":null,"region_id":1},"role":[{"id":"accounts_manager","active":null,"listed":true,"create
d_at":"2019-02-28T03:13:17.000Z","updated_at":"2019-02-28T03:13:17.000Z","deleted_at":
null,"user_id":2602,"User_Role":{"id":"1100817238629603181","active":true,"end_date":null
,"paused":false,"created_at":"2019-04-22T15:26:44.000Z","updated_at":"2023-03-15T12:41:
32.000Z","deleted_at":null,"user_id":2602,"role_id":"accounts_manager","region_id":1}},{"id
":"project_manager","active":null,"listed":true,"created_at":"2019-02-28T03:13:17.000Z","u
pdated_at":"2019-02-28T03:13:17.000Z","deleted_at":null,"user_id":2602,"User_Role":{"id":
"12296603864669290297","active":true,"end_date":null,"paused":false,"created_at":"2019-
04-22T15:26:44.000Z","updated_at":"2023-03-15T12:41:30.000Z","deleted_at":null,"user_id
":2602,"role_id":"project_manager","region_id":1}},{"id":"designer","active":null,"listed":true
,"created_at":"2019-02-28T03:13:17.000Z","updated_at":"2019-02-28T03:13:17.000Z","delet
ed_at":null,"user_id":2602,"User_Role":{"id":"14090843531555790923","active":true,"end_d
ate":null,"paused":false,"created_at":"2019-04-22T15:26:44.000Z","updated_at":"2023-03-1
5T12:41:27.000Z","deleted_at":null,"user_id":2602,"role_id":"designer","region_id":1}},{"id":
"catalog_manager","active":null,"listed":true,"created_at":"2019-02-28T03:13:17.000Z","up
dated_at":"2019-02-28T03:13:17.000Z","deleted_at":null,"user_id":2602,"User_Role":{"id":"
4651854471348561891","active":true,"end_date":null,"paused":false,"created_at":"2019-04
-22T15:26:44.000Z","updated_at":"2023-03-15T12:41:29.000Z","deleted_at":null,"user_id":2
602,"role_id":"catalog_manager","region_id":1}}]},{"id":2609,"type":null,"first_name":"Test",
"last_name":"Designer","contact":null,"orphan":null,"allow_store_plugin_usage":true,"allow
_store_design_usage":true,"onboarding_prompt":null,"onboarding_project_prompt":null,"d
eprecated":false,"created_at":"2019-04-23T08:30:49.000Z","updated_at":"2023-03-06T08:0
7:13.000Z","deleted_at":null,"store_id":"1555946804115","login_id":"598863161740261846
4","display_pic_id":null,"active_designer_user_role_id":"6989828210069237034","region_id
":1,"login":{"id":"5988631617402618464","default_user_id":2609,"email":"api_test_designer
@infurnia.com","username":null,"orphan":null,"region_id":1},"role":[{"id":"designer","active"
:null,"listed":true,"created_at":"2019-02-28T03:13:17.000Z","updated_at":"2019-02-28T03:1
3:17.000Z","deleted_at":null,"user_id":2609,"User_Role":{"id":"6989828210069237034","act
ive":true,"end_date":null,"paused":false,"created_at":"2019-04-23T08:30:49.000Z","updated
_at":"2023-03-15T12:41:27.000Z","deleted_at":null,"user_id":2609,"role_id":"designer","regi
on_id":1}}]},{"id":10975,"type":null,"first_name":"test_user","last_name":"","contact":null,"o
rphan":null,"allow_store_plugin_usage":true,"allow_store_design_usage":true,"onboarding_
prompt":null,"onboarding_project_prompt":null,"deprecated":false,"created_at":"2020-10-1
9T05:58:16.000Z","updated_at":"2023-03-06T08:07:31.000Z","deleted_at":null,"store_id":"1
555946804115","login_id":"3ecb2a907c39bd2c","display_pic_id":null,"active_designer_user
_role_id":"e4c1d117f3d263d9","region_id":1,"login":{"id":"3ecb2a907c39bd2c","default_use
r_id":10975,"email":"[email protected]","username":null,"orphan":null,"r
egion_id":1},"role":[{"id":"project_manager","active":null,"listed":true,"created_at":"2019-02
-28T03:13:17.000Z","updated_at":"2019-02-28T03:13:17.000Z","deleted_at":null,"user_id":1
0975,"User_Role":{"id":"54e3b66410d43a3a","active":true,"end_date":null,"paused":false,"c
reated_at":"2020-10-19T05:58:16.000Z","updated_at":"2023-03-15T12:41:30.000Z","delete
d_at":null,"user_id":10975,"role_id":"project_manager","region_id":1}},{"id":"catalog_manag
er","active":null,"listed":true,"created_at":"2019-02-28T03:13:17.000Z","updated_at":"2019-
02-28T03:13:17.000Z","deleted_at":null,"user_id":10975,"User_Role":{"id":"773eca5cd6b26
018","active":true,"end_date":null,"paused":false,"created_at":"2020-10-19T05:58:16.000Z",
"updated_at":"2023-03-15T12:41:29.000Z","deleted_at":null,"user_id":10975,"role_id":"cata
log_manager","region_id":1}},{"id":"accounts_manager","active":null,"listed":true,"created_
at":"2019-02-28T03:13:17.000Z","updated_at":"2019-02-28T03:13:17.000Z","deleted_at":nu
ll,"user_id":10975,"User_Role":{"id":"c805daedd9ec4c47","active":true,"end_date":null,"pau
sed":false,"created_at":"2020-10-19T05:58:16.000Z","updated_at":"2023-03-15T12:41:32.00
0Z","deleted_at":null,"user_id":10975,"role_id":"accounts_manager","region_id":1}},{"id":"d
esigner","active":null,"listed":true,"created_at":"2019-02-28T03:13:17.000Z","updated_at":"
2019-02-28T03:13:17.000Z","deleted_at":null,"user_id":10975,"User_Role":{"id":"e4c1d117f
3d263d9","active":true,"end_date":null,"paused":false,"created_at":"2020-10-19T05:58:16.0
00Z","updated_at":"2023-03-15T12:41:27.000Z","deleted_at":null,"user_id":10975,"role_id":
"designer","region_id":1}}]}],"message":"call success"}
