Password Pusher 应用程序接口 v2

测试版

用于集成的全面 REST API 文档 Password Pusher 到您的应用程序中

测试版通知： API v2 目前处于测试阶段。虽然我们已尽一切努力确保稳定性，但在最终发布前可能会有突破性的改动。欢迎您提出反馈意见！

工作空间

工作区是 Password Pusher 为团队和个人组织推送和请求的方式。一个用户可以属于多个工作区。创建推送或请求时，通过传递 workspace_id 参数，其中包含工作区 id。

注：该参数以前的名称为 account_id并更名为 workspace_id.遗产 account_id 名称仍可接受，以便向后兼容。

默认情况下，您只有一个工作区。在 pwpush.com，您可以为您的团队或组织创建其他工作区。在自托管专业版中，只为您创建一个工作区。

列出工作区 GET /api/v2/workspaces 或同等学历 GET /api/v1/workspaces.在 API v1 和 v2 中，传统路径 GET /api/v1/accounts 和 GET /api/v2/accounts 返回相同的 JSON。

GET /api/v2/workspaces

遗留别名： GET /api/v2/accounts (答复相同）。

返回已验证用户所属的每个工作区。使用每个项目的 id 作为 workspace_id 创建推送或请求时。

申请示例

curl -X GET https://us.pwpush.com/api/v2/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://us.pwpush.com/api/v2/workspaces')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

import requests
import json

url = 'https://us.pwpush.com/api/v2/workspaces'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=2))

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
}

$response = Invoke-RestMethod -Uri 'https://us.pwpush.com/api/v2/workspaces' `
    -Method Get `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

答复示例

[
  {
    "id": 1,
    "name": "My Personal Workspace",
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z"
  },
  {
    "id": 2,
    "name": "Acme Corporation",
    "created_at": "2023-10-20T08:00:00.000Z",
    "updated_at": "2023-10-20T08:00:00.000Z"
  }
]

响应字段

现场	类型	描述
`id`	integer	工作区的数字 id。将此值作为 `workspace_id` 创建推送或请求时。
`name`	string	工作区的显示名称
`created_at`	string (ISO 8601)	创建工作区时
`updated_at`	string (ISO 8601)	工作区上次更新的时间

锁定工作区

在创建推送或请求时，可以选择通过 workspace_id 将资源与特定工作区关联。如果省略，资源将在默认工作区中创建。

请注意： 该参数之前被命名为 account_id并更名为 workspace_id.遗产 account_id 名称，但新的集成应使用 workspace_id.

重要： 您只能使用自己所属的工作区 ID。使用其他工作区的 id 会返回 401 Unauthorized.