English

简体中文

English

简体中文

Appearance

About Authorization ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Authorization is the process of granting application permissions. When merchants install an application and consent to its requested permissions on the Genstore platform, the platform issues an access token with the corresponding permission scope. Applications use this token to interact with the Genstore platform.

Core Features

  • Permission Scope Query: Provide interfaces to query current application permission scopes.

Use Cases

  • Permission Scope Update: Applications can retrieve current permissions through the scope query interface. When new permissions are required, merchants will be guided to update their authorization.

Endpoints

DELETE /api/202412/oauth2/uninstall: Uninstall app

GET /api/202412/oauth2/access_scopes: Get access scopes

Access scope Object ​

Authorized application access scope.

Properties ​

accessScopesstring
A list of permissions that access tokens have
bash
{
  "accessScopes": "[read_orders,write_orders]"
}

DELETE Uninstall app ​

Uninstalls an application from the system. If no user intervention is required, automatically sends a request to remove the application from the store.

Access scope

Requires ANY of the following access scopes: write_apps

Endpoint

DELETE /api/202412/oauth2/uninstall 

Request Params

{}

Response Data

{}
bash
curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/oauth2/uninstall" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{}

GET Get access scopes ​

The AccessScope resource allows you to retrieve the permissions that a merchant has granted to an app, such as read_orders and write_products. These permissions allow apps to access data from a shop, and are granted when a merchant installs the app or updates an existing installation of the app.
The list of access scopes retrieved is based on the access token for the request. It returns only those access scopes that are associated with the token.

Access scope

Requires ANY of the following access scopes: write_apps read_apps

Endpoint

GET /api/202412/oauth2/access_scopes 

Request Params

{}

Response Data

accessScopesarray
A list of permissions that access tokens have.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/oauth2/access_scopes" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "accessScopes": "[read_orders,write_orders]"
}