FS Developer Portal

FS API Authentication and Authorization

To use FS API services, please reference the Getting Started Guide to obtain FS API credentials.

Obtain your API account client ID & client secret: once your API account request has been approved and created, FS team will assign and send a pair of client ID and client secret to you. You must provide the credentials per function as authentication in order to access FS API services.

Important!

We highly recommend that you do not let any unauthorized personnel or 3rd party developers have access to your original pair of API client ID and client secret. Anyone with this information can access our FS API services as you. The system will automatically deactivate API credentials if there are no calls made with them within 90 days.

EndPoint

Enviroment	EndPoint
PROD	https://open.fs.com

Rate Limit

Rate limits are divided into minute intervals. This means you have a maximum number of requests you can submit to a specific function in a one-minute period.

Per-client quota limit per second

10 (May not be reached)

Interface frequency limit

60 times/minute

Obtain authorization code

Basic

HTTP URL

/oauth/token

HTTP METHOD

POST

Interface frequency limit

10 times/minute

Permission requirements

Request header

Name	Type	Parameter
Content-Type	String	application/x-www-form-urlencoded

Request parameters

To access FS API services, you must provide authentication information listed below:

Name	Required?	Description	Type
client_id	✓	the unique client ID which FS team assigned to you	string
client_secret	✓	the unique Secret Key which FS team assigned to you	string
grant_type	✓	License Type: client_credentials	string

Example: HTTP, Request


curl --location --request POST 'https://open.fs.com/oauth/token'
     --header 'Content-Type: application/x-www-form-urlencoded'
     --data-urlencode 'grant_type=client_credentials'
     --data-urlencode 'client_secret=your_client_secret'
     --data-urlencode 'client_id=your_client_id'

Response

Name	Description
code	Status code: 200 indicates successful response; 401 indicates authentication failure
data.access_token	Authorization code: used for resource service data requests, the access_token into the subsequent interface header request header.
data.token_type	Authorization code type, default is Bearer Token
data.expires_in	Authorization code expiration time

Example: JSON, Response

1{
2  "code": 200,
3  "message": "Success",
4  "traceId": "jGSY624889657237573",
5  "extend": null,
6  "data": {
7    "access_token": "your_access_token",
8    "token_type": "Bearer",
9    "expires_in": 1799
10  }
11}