Authentication Method

Last Updated on : 2024-06-13 08:21:51download

A token is required to authenticate and authorize API calls. The cloud APIs comply with the OAuth 2.0 implicit authorization.

Simple mode

Applicability

The simple mode applies to access to data created by or associated with a cloud project.

Get access token

GET:/v1.0/token?grant_type=1

Required parameters: client_id (the request header), secret (used to sign the request), and grant_type (fixed to 1).
References: View Project Details for the client_id and secret, Sign Requests for Cloud Authorization for the signing algorithms, and Get a Token for the API reference.

Data sources and API permissions

Data source	API permission
The PID associated with the cloud project	PID permission package
The mobile app or WeChat mini program associated with the cloud project	Mobile app/WeChat Mini Program permission package
The user associated with the cloud project	User permission package

OAuth 2.0

Applicability

The code mode applies to access to user data.

Get access token

GET:/v1.0/token?grant_type=2&code=cf2xxxxxxxxxxxxxxxxxxxxxxxxxx8fe

Required parameters: client_id (the request header), secret (used to sign the request), code (user authorization code), and grant_type (fixed to 2).
References: View Project Details for the client_id and secret.
- If your client_id comes from app authorization, see Sign Requests for App Authorization for the signing algorithms.
- If your client_id comes from cloud Authorization, see Sign Requests for Cloud Authorization for the signing algorithms.
- Get a Token for the API reference.

If you are using OAuth 2.0 authorization mode on terminal, client_id must be created from App Authorization. This type of client_id is more secure, and can avoid large-scale security issues caused by the leakage of client_id and secret on terminal.

Data sources and API permissions

Data source	API permission
User authorization via the webpage	User permission package

Prev DocRequest Structure

Next DocPID Permission Package