Password Pusher API v2

ベータ

統合のための包括的なREST APIドキュメント Password Pusher アプリケーションに

ベータ版のお知らせ： API v2は現在ベータ版です。安定性を確保するためにあらゆる努力をしていますが、最終リリースまでに変更される可能性があります。フィードバックをお待ちしております！

ワークスペース

ワークスペースは、Password Pusherがチームや個人のプッシュやリクエストを整理する方法です。ユーザーは複数のワークスペースに属することができます。プッシュやリクエストを作成するときは、特定のワークスペースに workspace_id パラメータにワークスペースIDを指定する。

注：このパラメータは以前は account_idに改名した。 workspace_id.遺産 account_id という名前は、後方互換性のためにまだ受け入れられている。

デフォルトでは、ワークスペースは1つです。pwpush.comでは、チームや組織のために追加のワークスペースを作成することができます。Self-Hosted Proでは、ワークスペースは1つしか作成されません。

ワークスペースを 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://eu.pwpush.com/api/v2/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"

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

uri = URI('https://eu.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://eu.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://eu.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 のみ使用できます。他のワークスペースの ID を使用すると 401 Unauthorized.

Password Pusher API v2

ワークスペース

ワークスペース一覧

リクエスト例

回答例

応答フィールド

ワークスペースをターゲットにする