跳至内容
ShopentlyLearn
简体中文

身份验证

创建 API 密钥

要将应用连接到店铺，你需要一个 API 密钥。在管理后台选择权限，指定应用可以读取哪些数据，以及可以修改哪些内容。

你也可以指定应用访问 API 时使用的 IP 地址。填写后，密钥只能从这些地址使用。完成设置后创建 API 密钥。

获取访问令牌

使用访问令牌发送请求时，无需在每个请求中传递 API 密钥。不再需要令牌时，可以将其撤销。

获取令牌时，还会收到店铺可用的权限和 API 请求速率限制。

POST/api/v1/auth/token

cURL 请求 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/token \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"ttl_seconds":1800}'

响应 

{
  "data": {
    "access_token": "EXAMPLE_ACCESS_TOKEN",
    "expires_at": "2026-01-01T12:15:00Z",
    "expires_in": 1800,
    "permissions": [
      "orders.order:read"
    ],
    "rate_limits": {
      "auth_per_minute": 1,
      "read_per_minute": 2,
      "write_per_minute": 15
    },
    "token_type": "Bearer",
    "warnings": []
  },
  "meta": {
    "request_id": "example"
  }
}

发送 API 请求

发送 API 请求时，请使用获取到的令牌。不要超过店铺的请求限制。能否访问各项操作也取决于套餐包含的权限。

如果需要为请求选择语言或市场，请获取店铺上下文。响应会提供可用的语言和市场，以及各自的代码和标识符。

撤销令牌

撤销令牌是可选操作。如果仅用于一次性任务，建议在任务完成后撤销。如果不手动撤销，令牌会一直有效到设定的期限结束。之后将无法再使用。

POST/api/v1/auth/revoke

cURL 请求 

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request POST \
  --url https://shop.onshopently.com/api/v1/auth/revoke \
  --header 'Authorization: ApiKey EXAMPLE_API_KEY' \
  --header 'Content-Type: application/json' \
  --data-raw '{"access_token":"EXAMPLE_ACCESS_TOKEN"}'

响应 

{
  "data": {
    "revoked": true
  },
  "meta": {
    "request_id": "example-request"
  }
}