Password Pusher API v2

BÉTA

Átfogó REST API dokumentáció az integráláshoz Password Pusher az alkalmazásokba

Béta értesítés: Az API v2 jelenleg béta verzióban van. Bár mindent megtettünk a stabilitás biztosítása érdekében, a végleges kiadás előtt még lehetnek törésszerű változások. Szívesen fogadjuk visszajelzéseit!

Munkaterületek

A Password Pusher a munkaterületek segítségével szervezi a csapatok és az egyének pushjait és kéréseit. Egy felhasználó több munkaterülethez is tartozhat. A push-ok vagy kérések létrehozásakor egy adott munkaterületet célozzon meg a workspace_id paramétert a munkaterület azonosítójával.

Megjegyzés: Ezt a paramétert korábban account_id és átnevezték workspace_id. Az örökség account_id név továbbra is elfogadott a visszafelé kompatibilitás érdekében.

Alapértelmezés szerint egy munkaterület áll rendelkezésre. A pwpush.com oldalon további munkaterületeket hozhat létre a csapata vagy szervezete számára. A Self-Hosted Pro szolgáltatásban csak egy munkaterület jön létre az Ön számára.

Listázza a munkaterületeket GET /api/v2/workspaces vagy azzal egyenértékű GET /api/v1/workspaces. Az API v1-ben és v2-ben a régi útvonalakat GET /api/v1/accounts és GET /api/v2/accounts ugyanazt a JSON-t adja vissza.

GET /api/v2/workspaces

Legacy alias: GET /api/v2/accounts (azonos válasz).

Visszaad minden olyan munkaterületet, amelyhez a hitelesített felhasználó tartozik. Használja az egyes elemek id mint workspace_id a push-ok vagy kérések létrehozásakor.

Példa kérés

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

Példa Válasz

[
  {
    "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"
  }
]

Válaszmezők

Terep	Típus	Leírás
`id`	integer	A munkaterület numerikus azonosítója. Ezt az értéket adja át `workspace_id` a push-ok vagy kérések létrehozásakor.
`name`	string	A munkaterület megjelenített neve
`created_at`	string (ISO 8601)	A munkaterület létrehozásakor
`updated_at`	string (ISO 8601)	A munkaterület utolsó frissítésének időpontja

Munkaterület megcélzása

A push-ok vagy kérések létrehozásakor opcionálisan átadhatja a workspace_id az erőforrást egy adott munkaterülethez társíthatja. Ha kihagyja, az erőforrás az alapértelmezett munkaterületen jön létre.

Megjegyzés: Ezt a paramétert korábban account_id és átnevezték workspace_id. Az örökség account_id név továbbra is elfogadott a visszafelé kompatibilitás érdekében, de az új integrációknak a workspace_id.

Fontos: Csak olyan munkaterület-azonosítókat használhat, amelyekhez tartozik. Egy másik munkaterület azonosítójának használata 401 Unauthorized.