Password Pusher API v2

BETA

Kompleksowa dokumentacja interfejsu API REST do integracji Password Pusher do aplikacji

Powiadomienie o wersji beta: API v2 jest obecnie w wersji beta. Chociaż dołożyliśmy wszelkich starań, aby zapewnić stabilność, przed ostatecznym wydaniem mogą pojawić się przełomowe zmiany. Czekamy na Twoją opinię!

Przestrzenie robocze

Przestrzenie robocze to sposób, w jaki program Password Pusher organizuje powiadomienia push i żądania dla zespołów i osób. Użytkownik może należeć do wielu obszarów roboczych. Podczas tworzenia powiadomień push lub żądań należy określić konkretny obszar roboczy, przekazując wartość workspace_id z identyfikatorem obszaru roboczego.

Uwaga: Ten parametr był wcześniej nazywany account_id i zmieniono nazwę na workspace_id. Dziedzictwo account_id jest nadal akceptowana ze względu na kompatybilność wsteczną.

Domyślnie masz jeden obszar roboczy. W witrynie pwpush.com można utworzyć dodatkowe obszary robocze dla zespołu lub organizacji. W Self-Hosted Pro tworzony jest tylko jeden obszar roboczy.

Lista obszarów roboczych z GET /api/v2/workspaces lub odpowiednik GET /api/v1/workspaces. W API v1 i v2 starsze ścieżki GET /api/v1/accounts i GET /api/v2/accounts zwracają ten sam JSON.

GET /api/v2/workspaces

Dotychczasowy alias: GET /api/v2/accounts (identyczna odpowiedź).

Zwraca każdy obszar roboczy, do którego należy uwierzytelniony użytkownik. Użyj atrybutu id jak workspace_id podczas tworzenia pushów lub żądań.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Pola odpowiedzi

Pole	Typ	Opis
`id`	integer	Numeryczny identyfikator obszaru roboczego. Przekaż tę wartość jako `workspace_id` podczas tworzenia pushów lub żądań.
`name`	string	Wyświetlana nazwa obszaru roboczego
`created_at`	string (ISO 8601)	Kiedy obszar roboczy został utworzony
`updated_at`	string (ISO 8601)	Kiedy obszar roboczy został ostatnio zaktualizowany

Określanie obszaru roboczego

Podczas tworzenia pushów lub żądań można opcjonalnie przekazać workspace_id aby powiązać zasób z określoną przestrzenią roboczą. Jeśli opcja ta zostanie pominięta, zasób zostanie utworzony w domyślnym obszarze roboczym.

Uwaga: Parametr ten nosił wcześniej nazwę account_id i zmieniono nazwę na workspace_id. Dziedzictwo account_id jest nadal akceptowana ze względu na kompatybilność wsteczną, ale nowe integracje powinny używać workspace_id.

Ważne: Możesz używać tylko identyfikatorów obszarów roboczych, do których należysz. Użycie identyfikatora innego obszaru roboczego zwraca 401 Unauthorized.