1. Preliminary preparation
CloudNest Open Platform API Documentation
  • Preliminary preparation
    • 0. Introduction
    • a. Use our demo to quickly generate request headers
    • b. Manually create the request header
    • 1. API Quota & API Rate Limit
    • 2. Data Dictionary
  • part
    • Generate parts (imported from nc1)
      POST
    • Generate parts (JS template)
      POST
    • Generate parts (DXF file)
      POST
    • Generate parts (SmartDraw)
      POST
    • Retrieve the full list of parts
      POST
    • Retrieve the list of parts on the layout (returned in order of their physical positions)
      POST
    • Copy parts
      POST
    • Update and delete part information
      POST
    • Update the custom properties of a part
      POST
  • plate
    • Retrieve scrap sheet hierarchy details
      GET
    • Add plate
      POST
    • Retrieve plate list
      POST
    • Update plate information
      POST
  • drawing
    • Query drawing information
      POST
    • Upload DXF drawing to the job (upload file).
      POST
    • Upload dxf drawings to the job (active download)
      POST
    • Delete DXF drawing (force delete)
      POST
    • Delete DXF drawing (cannot be deleted if processed or being processed)
      POST
  • material
    • Add Material
      POST
    • Get Material List
      GET
  • job
    • Query job information by job ID
    • Add Job
    • Get Job List
    • Get Parts List under the Job
    • Get Layout List under the Job
    • Get the formatting details of the assignment
    • Get the production schedule list of the assignment
    • Get the part layout information under the assignment
    • Get the list of plates used in the assignment
    • Get the production task details under the assignment
    • Search the assignment (exact search by assignment name)
    • Delete job
    • Query the drawing processing status under the specified job
    • Get the nesting details under the job (return the DXF download link of the nesting and the part serial numbers)
    • Boost
    • Query job information by job ID (flat view)
    • Delete nesting
  • production
    • Query completed task list for the machine tool
    • Get production task details
    • Server-side - Push the layout to the CNC machine
  • Part Text Recognition
    • Get user-defined text recognition configuration
    • Drawing processing text recognition configuration
  • others
    • Get job and material information based on the layout GUID
    • Get the parts list based on the layout GUID
  1. Preliminary preparation

0. Introduction

This document aims to help developers swiftly master third-party platform development by introducing some common basic concepts.
DEV MSG: We support customized query time zone now! check the documentation!

1. Introduction to Terminology#

TermDescription
appIdOpen platform appId
appSecretOpen platform appSecret
timestampTimestamp required when calling the API
appSignThe security signature needed for API calls, generated based on appId, appSecret, and timestamp. The specific generation rule can be found at: https://cloudopen-en.apifox.cn/doc-6374059
X-FS-OrgcodeThe OrgCode of the team being integrated with CloudNest.
zoneIdFor users who are not in China or whose local time zone differs from Beijing Time(UTC+8:00), we received your message and now offer a method for querying machine data based on your local time zone! You can specify the time zone for query parameters and return values by including the request header zoneId when calling certain APIs. Check the Api doc
📌
appId, appSecret, and appSign are fundamental for OpenApi calls, serving as pre-call identification.The X-FS-Orgcode is the team code for interfacing with BoChu CloudNest. The retrieval method is as follows:

1.1. Create Organizations and Obtain OrgCode#

For client implementation and integration, each customer organization requires a unique OrgCode. Follow these steps:

Step 1: Create an Organization#

1.
Log in to the "Bochu CloudNest" application and click the profile icon in the upper-right corner. Then, select “Switch to Team”:
Switch to Team
2.
In the pop-up window, click “Create New Team”:
Create New Team
3.
Enter the team name (usually the client's company name) and complete the creation:
Enter Team Name

Step 2: Obtain OrgCode#

1.
Log in to the "Bochu Cloud Nesting" application, click the profile icon in the upper-right corner, and select “Switch to Team”:
Switch to Team
2.
The string following the team name is the OrgCode of the current team.
3.
To add additional users to the team, invite them to join the organization:
Invite Members

2. Application Steps#

First, go to my machine tool open interface platform: https://open.fscut.com/

2.1 Login with email#

① Click email Login button
image.png
② Login with email
image.png
💡
If you are new user in Friendess, please follow the register
tutorial.
image.png
image.png
image.png
image.png
image.png
image.png

2.2 Enter Personal Center#

After successfully scanning and logging in, you will be directed to the dashboard. Click on the personal center button located in the top menu bar.
image.png

2.3 Obtain appId & appSecret#

Once you're on the personal center page, you can directly view your appId.
image.png
📌
appSecret is sensitive information that users should handle with care.

2.4 Contact our support team to request access permissions.#

Newly registered users do not have access to the CloudNest API. To request permissions, scan the QR code or send mail to support@bochu.com to contact customer support.
套料对接 _ Nesting API 群二维码.png
📌
When contacting customer support, you may need to provide:
Your AppID (copy it from your Account Settings)
A valid Business License
Your orgCode (refer to Section 1.1 for retrieval instructions)
Congratulations! At this moment, you've obtained all the prerequisites for using OpenApi.

3. My First API Call#

📌
API calls require the following headers: app-id, time-stamp, and app-sign.
① app-id: It is the appId you acquired earlier.
② time-stamp: Timestamp valid for ten minutes before and after the API call moment.
③ app-sign: A signature computed using app-id, app-secret, and time-stamp.
④ X-FS-Orgcode: Refer to Section 1.1
Example:
{
    "app-id": "op18725d72811234d2", 
    "time-stamp": 1680592492719, 
    "app-sign": "c227fc9d75471a36e3dee7bd4cc8630e",
    "X-FS-Orgcode": "TEAM001"
}

3.1 Generation Methods#

3.1.1 Quick Solution#
Considering user convenience, Friendess has created header generation demos for popular languages.
Head to: https://cloudopen-en.apifox.cn/doc-6374056
3.1.2 Manual Generation#
💡
If your preferred language is not available in the above quick solution, you can contact Bochu customer service or manually generate the request headers.
For more details, visit: https://cloudopen-en.apifox.cn/doc-6374059

4 Start Making Calls!#

API interfaces open to users can be seen in the API documentation module of the open platform.
Head to: https://open.fscut.com/#/api
image.png
Find the interface you're interested in and get started!

4.1 Points to Note#

📌
There are daily maximum calls and frequency restrictions for API calls. For more details, refer to: https://fscut-open-en.apifox.cn/doc-2946220
Modified at 2025-07-28 13:48:02
Next
a. Use our demo to quickly generate request headers
Built with