Overview
API Introduction
You can fully utilize the platform’s functions by calling the API we provide.
The API we provide is designed following the RESTful principles, allowing you to interact with it using any programming language you prefer.
Currently, most APIs only accept requests in the application/json format and use application/json as the format for returning content.
Caution: The request content needs to be encoded using UTF-8, otherwise we will not be able to decode some special characters.
All the operations you perform on the platform’s webpage have corresponding APIs, so you can use the API to complete all your operations on our platform.
Documentation Conventions
This document will introduce you to the API calling method, authentication method, and API description, helping you quickly understand how to use our API to develop your application.
Before you read this document, please familiarize yourself with the conventions in the document so that you can better use the services we provide.
| Convention | Explanation |
|---|---|
| {} parameters are variables | In the document, this symbol represents a variable parameter, which needs to be replaced with the actual environment parameters when calling the interface. For example, in the request line of the “View User Details” interface GET /apis/auth.example.io/v1/users/{name}, the {name} needs to be replaced with the actual user name when calling the interface. |