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#
2.1 Login with email#
ā Click email Login button
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'.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
.
{
"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.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.
4 Start Making Calls!#
API interfaces open to users can be seen in the API documentation module of the open platform.Find the interface you're interested in and get started!4.1 Points to Note#