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

Term	Description
appId	Open platform appId
appSecret	Open platform appSecret
timestamp	Timestamp required when calling the API
appSign	The security signature needed for API calls, generated based on `appId`, `appSecret`, and `timestamp`. The specific generation rule can be found at: https://fscut-open-en.apifox.cn/doc-2946218
zoneId	For 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.

2. Application Steps

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

① Click email Login button

② Login with email

💡

If you are new user in Friendess, please follow the register
tutorial.

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.

2.3 'My Machine' Verification

Upon entering the personal center, check the verification user identification in the top right corner to confirm whether you are a verified user of 'My Machine'.

📌

If you are not a verified user, you won't be able to use OpenApi. Please first go to My Machine for verification. The specific verification process can be referred to at: https://fscut-open-en.apifox.cn/doc-2946219

2.4 Obtain appId & appSecret

Once you're on the personal center page, you can directly view your appId.

📌

appSecret is sensitive information that users should handle with care.

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.

Example:

{
    "app-id": "op18725d72811234d2", 
    "time-stamp": 1680592492719, 
    "app-sign": "c227fc9d75471a36e3dee7bd4cc8630e"
}

3.1 Generation Methods

3.1.1 Quick Solution

Considering user convenience, Friendess has created header generation demos for popular languages.

Head to: https://fscut-open-en.apifox.cn/doc-2946217

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://fscut-open-en.apifox.cn/doc-2946218

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

Find the interface you're interested in and get started!

4.1 Points to Note

📌

① Users can only call accessible devices from their device list. For more details, refer to: https://fscut-open-en.apifox.cn/doc-2946219
② There are daily maximum calls and frequency restrictions for API calls. For more details, refer to: https://fscut-open-en.apifox.cn/doc-2946220

1. Introduction to Terminology#

2. Application Steps#

2.1 Login with email#

2.2 Enter Personal Center#

2.3 'My Machine' Verification#

2.4 Obtain appId & appSecret#

3. My First API Call#

3.1 Generation Methods#

3.1.1 Quick Solution#

3.1.2 Manual Generation#

4 Start Making Calls!#

4.1 Points to Note#