Authentication
Usage
Overview
OpenAPI uses API keys for authentication. Get your API token from our API interfaces . We provide open APIs for main GenAI Marketing platform by clicking on the top left API button on this page Content and face swap API button on this page Faceswap.
- First you need to login to our website.
- Then click the picture icon in the upper right corner of the website, and click the “APl Credentials” function to set the key pair (clientId, clientSecret) used when accessing the API and save it.
- Use the secret key pair just saved to send the api interface to obtain the access token.
API
Get the token
Body Attributes
Parameter | Description |
---|---|
clientId | Used for request creation authorization |
clientSecret | Used for request creation authorization |
Response Attributes
Parameter | Value | Description |
---|---|---|
code | 1000 | Interface returns business status code(1000:success) |
token | API token |
Please note that the generated token is valid for more than 1 year.
Example
Body
Request
Response
All API requests should include your API token in the HTTP header, Authorization looks like this:
Remember, your API token is secret! Do not share it with others or expose it in any client-side code (browser, application). Production requests must be routed through your own backend server, and your API token can be securely loaded from environment variables or a key management service.
Response Code Description
Please note that if the value of the response code is not equal to 1000, the request is failed or wrong
Parameter | Value | Description |
---|---|---|
code | 1000 | Success |
code | 1101 | Invalid authorization or The request token has expired |
code | 1102 | Authorization cannot be empty |
code | 1200 | The account has been banned |