跳转到主内容

认证

4pay.online 支持以下两种合作伙伴 API 身份验证方式。

方法 1 — API 密钥( 建议)​

每次请求都必须同时携带 x-api-key 和 x-organization-id 请求头。 x-api-key 提供 API 密钥，x-organization-id 指定密钥所属的组织。 平台只在指定组织内查找密钥；缺少组织标识时，请求会在验证密钥之前被拒绝。 应将 400 和 401 都视为凭据不可用：部分端点对缺少请求头的情况返回 400 Bad Request，而不是 401。运营方会同时提供这两个值。 API 密钥适用于服务器之间的集成。

curl https://4pay.online/api/v1/transactions \
  -H "x-api-key: pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "x-organization-id: 00000000-1111-2222-3333-444444444444"

如何获取 API 密钥：

  1. 登录到 合作伙伴领域
  2. 打开 设置 → API 密钥
  3. 单击 创建密钥 ——立即复制值,只显示一次
保护 API 密钥

将 API 密钥保存在环境变量中。不得将其提交到版本库或放入客户端代码。

方法 2 ——Bearer 令牌（基于会话）​

交互式应用可以使用登录名和密码获取 Bearer 令牌。

创建会话​

curl -X POST https://4pay.online/api/v1/session \
  -H "Content-Type: application/json" \
  -d '{
    "type": "partner",
    "login": "your-login",
    "password": "your-password"
  }'

答复:

{
  "token": "b7f0c9d2-1e4a-4c8b-9f31-2a5d6e7c8b90",
  "refresh_token": "1acdd2f3-299a-4213-a2df-39b6fae4d165",
  "inserted_at": 1788434490,
  "expire_at": 1789039290
}
过期字段

It is expire_at - 单数,和 解开秒,而不是一个 ISO 8601 字符串。 代码写入了反对 an expires_at 时间戳读取 undefined 将符物当作不朽的,然后开始失败 一周后没有明显原因,会议持续七天。

使用符号​

curl https://4pay.online/api/v1/transactions \
  -H "Authorization: Bearer eyJhbGci..."

刷新会话​

curl -X PUT https://4pay.online/api/v1/session \
  -H "Content-Type: application/json" \
  -d '{
    "refresh_token": "1acdd2f3-299a-4213-a2df-39b6fae4d165"
  }'

结束会话​

curl -X DELETE https://4pay.online/api/v1/session \
  -H "Authorization: Bearer eyJhbGci..."

比较​

API 密钥熊熊托肯语Name
设置一次性,无过期每次会话都需要登录
最佳办法服务器对服务器的集成交互式/仪表板应用程序
** 页眉**x-api-key: YOUR_KEYAuthorization: Bearer TOKEN
撤销删除合作伙伴区域中的密钥DELETE /session 或密钥过期

HTTP 反应代码​

代码含义
200成绩
201创造的资源—— ** 没有** 接受付款的证明;改为: status
400坏请求——身体畸形,或缺失 x-organization-id
401未经授权——证书遗失或无效
403禁止——有效证书但许可不足
422校验错误——检查 errors 字段在响应中
429费率有限——减慢请求
500内部服务器错误——联系人支持