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

1. API Quota & API Rate Limit

1. Understanding of Terminology#

TermDescription
API QuotaThe maximum number of daily API calls. For instance, if the API quota is 1000, it means a maximum of 1000 calls can be made in a day
API Rate LimitThe frequency limit for API calls. For instance, if the API rate limit is 1/s, it means one can call the API up to once per second
šŸ’”
Both API Quota and API Rate Limit are core restrictions for API calls.
Newly registered users start with zero quota for CloudNest API access. To obtain usage quota, please scan the QR code to contact customer support.

2. Checking the API Quota and Rate Limit#

ā‘  Scan the QR code to log in to the Friendess Open Platform: https://open.fscut.com/#/login
image.png
ā‘” Click on the personal center button at the top to view the quota and rate limit for each API.
image.png
šŸ’”
For users developed by third parties:
To view your API usage or limits, please contact the third party or Bochu customer service.

3. Insufficient API Quota or Need to Increase Rate Limit#

For enterprise customers requiring higher API quotas, please scan the code to consult our sales team for customized service plans.
Modified atĀ 2025-04-02 02:11:21
Previous
b. Manually create the request header
Next
2. Data Dictionary
Built with