自动化

如何连接 easySales API:OAuth 客户端和个人访问令牌

如何连接 easySales API:OAuth 客户端和个人访问令牌

为 easySales API 创建 OAuth 客户端和个人访问令牌,选择合适的授权类型和作用域,避免各个连接互相挤掉登录。

API 设置有什么用

通过 easySales API,你自己的系统和合作伙伴的系统可以读取和修改你的数据:商品、库存、订单、发票等。API设置 是你创建这些系统所用访问凭据的地方。你可以在 设定值 → 帐户 → 设定值 中点击 API设置 按钮打开它,也可以通过 页面设置 → 整合方式 → API设置 进入。

开始之前要知道三件事:

  • 每个连接只有一个有效令牌。 当某个系统申请新令牌时,同一连接之前的令牌就会失效。为每个系统单独创建一个客户端,并让它重复使用自己的令牌,而不是每次都申请新的。
  • 个人访问令牌只显示一次。 创建时请立即复制。如果丢失了,就创建一个新的;旧令牌会失效。
  • 谨慎选择作用域。 令牌只能执行其作用域允许的操作,且作用域之后无法更改。
英文界面中的 API Settings 页面:OAuth Client 下有三个客户端——ERP connector(Password grant)、Online shop(Website grant)和 Reports dashboard(Redirect flow),显示其 Client ID 和 Secret;Authorized Applications 下有 Online shop 及其作用域;Personal Access Tokens 下有 Fulfilment partner。
客户端、授权应用程序和个人访问令牌都在同一页面上。
部分 包含内容
OAuth 客户 你的系统用来获取令牌的客户端,显示其 客户 ID、授权类型 和 密钥。
授权应用程序 持有你的某个 website 或 redirect 客户端所签发令牌的应用程序,以及它们的作用域。撤销 可停用其中一个。
个人访问令牌 你的个人访问令牌,按名称列出。删除 可停用其中一个。
API设置页面

创建 OAuth 客户端

  1. 点击 创建新客户。
  2. 在 名称 中填写一个便于识别的名字,例如将使用它的系统的名称。
  3. 选择 授权类型。如果选择 Redirect Flow Grant,还需填写你应用的重定向 URL。
  4. 点击 创造。客户端会出现在列表中,并显示其 客户 ID 和 密钥。
创建客户端的表单:Name 为 Online shop 2,Grant type 为 Website Grant 并附有说明,以及 Create 按钮。
为每个系统单独创建一个客户端。
授权类型 适用场景
Website Grant 连接到 easySales 的网店模块或自定义网店。除客户端 ID 和密钥外,它还使用网店的 website 令牌,你在“整合方式”中连接网店时即可获得。
Password Grant 你自己的系统,使用你的 easySales 账户登录信息获取令牌。
Redirect Flow Grant 需要你在 easySales 中批准访问、随后返回该应用的应用程序。重定向 URL 必须使用主机名,例如 localhost 或域名,而不是 IP 地址。
选择哪种授权类型

编辑 只能修改名称和重定向 URL。要更换密钥,请创建一个新客户端,把你的系统切换过去,然后用 删除 删掉旧的。删除客户端会立即停用用它签发的所有令牌。

创建个人访问令牌

个人访问令牌是一个现成的令牌,适用于只需要调用 API 的脚本、工具或合作伙伴。

  1. 点击 创建新令牌。
  2. 在 名称 中填写名字,并在 作用域 中勾选所需的项,或选择 全选。
  3. 点击 创造,并立即复制令牌。
Create Token 表单:Name 为 Warehouse app,Scopes 带有 Select all,已勾选 read-products、read-orders、update-orders 和 update-stock。
只勾选令牌需要的作用域。
新的个人访问令牌,以及提示这是唯一一次显示它的消息。
现在就复制令牌:它不会再次显示。

你的账户同一时间只有一个个人访问令牌:创建新令牌会使之前的令牌失效。如果有两个合作伙伴需要访问,请改为给他们各自创建 OAuth 客户端。

使用 API

  • 将请求发送到 https://easy-sales.com/api/v2,并带上请求头 Authorization: Bearer 加上你的令牌,以及 Accept: application/json。
  • 令牌有效期为一年。请保存好令牌,并在此期间重复使用。
  • 你的账户每分钟最多可发出 500 个请求,由其所有令牌共享。
  • 接口、字段和示例请参阅 API 文档:api.easy-sales.com。
📖
继续阅读
如何通过 API 将自定义商店接入 easySales
通过 API 把任意自定义或尚未支持的商店平台接入 easySales:需要的两个凭据、推送产品与库存、送入订单,以及把变化取回去。
→

你的团队与 API 设置

拥有 查看设置 权限的团队成员可以打开 API设置,看到你的 OAuth 客户端及其密钥,但不能创建、编辑或删除它们,也看不到个人访问令牌。只把这项权限授予应当能访问你的 API 凭据的人。

出现问题时

现象 处理方法
API 返回“Unauthenticated.” 该令牌已被同一客户端签发的新令牌取代,或已过期。每个系统使用一个客户端,并保留它获得的令牌。
API 返回“Invalid scope(s) provided.” 该令牌没有此请求所需的作用域。创建一个勾选了该作用域的新令牌。
我丢失了个人访问令牌 它无法再次显示。创建一个新的;旧令牌会失效。
API 返回的是网页而不是 JSON 在请求中添加请求头 Accept: application/json。
“Too Many Attempts.” 你的账户超过了每分钟 500 个请求。请放慢请求速度,并重复使用你的令牌。
我创建令牌后,某个合作伙伴失去了访问权限 创建个人访问令牌会使之前的令牌失效。请为每个合作伙伴单独创建 OAuth 客户端。
常见问题

常见问题

在 设定值 → 帐户 → 设定值 中,点击 API设置 按钮。你可以在那里创建 OAuth 客户端或个人访问令牌。

同一客户端签发了更新的令牌,或者令牌在一年后过期了。每个客户端只保留其最新的令牌。

不能。它只在创建时显示。如果丢失了,请创建一个新的。

不能。作用域在创建令牌时确定。请创建一个带有所需作用域的新令牌。

创建一个新客户端,把你的系统切换过去,然后删除旧客户端。删除后其令牌会立即停用。

你的账户每分钟最多 500 个请求,由其所有令牌共享。

在 api.easy-sales.com,包含接口、字段和示例。

本指南对你有帮助吗?