apilo/apilo-api-php

1.0.4 2024-03-07 09:23 UTC

This package is auto-updated.

Last update: 2024-09-07 14:21:05 UTC


README

Apilo.com 平台是一个现代化的多渠道销售管理系统。Apilo 允许通过文档中描述的官方 REST API 与任何系统进行集成 https://developer.apilo.com/api/

第一步

为了利用 Apilo REST API 的功能,您需要在 https://apilo.com/ 网站上创建一个账户。然后,创建账户并登录到管理面板后,转到“管理”->“Apilo API 密钥”选项卡并创建一个新的应用程序。

授权

创建应用程序后,您将收到一个一次性 authorization_code,用于生成访问令牌和刷新令牌对 (来源)。

为此,您需要发送 POST /rest/auth/token/ 请求,在头部发送 Authorization Basic(用户是“客户端 ID”,密码是“客户端密钥”),并在 JSON 主体值中发送 "grantType": "authorization_code""token": "{authorization_code}"。API 将返回 accessTokenrefreshToken

Apilo REST API 使用访问令牌和刷新令牌方案。这意味着通信使用 Authorization: bearer {accessToken} 头部(除了授权资源)(来源)。

访问令牌有效期为 21 天,因此为了保持与 REST API 的活动连接,需要发送一个包含令牌对的请求,通过执行 POST /rest/auth/token/ 请求发送在授权基本头部(与第一次授权相同)并发送在 JSON 主体中带有值 "grantType": "refresh_token""token": "{refreshToken}"

响应将返回新的 accessToken 和新的 refreshToken

实现

所有实现要求都在官方文档中描述,该文档可在 https://developer.apilo.com/api/ 获取。鼓励您使用可从文档顶部下载的 swagger.json 文件基于 OpenAPI 生成代码。如果您在项目中使用 PHP 语言,则建议您使用本存储库中的实现。

示例