Password Pusher API v2

BETA

Omfattande REST API-dokumentation för integrering Password Pusher i dina applikationer

Beta Meddelande: API v2 är för närvarande i betaversion. Även om vi har gjort allt för att säkerställa stabilitet kan det förekomma ändringar innan den slutliga utgåvan. Vi välkomnar din feedback!

Arbetsytor

Arbetsytor är hur Password Pusher organiserar pushar och förfrågningar för team och individer. En användare kan tillhöra flera arbetsytor. När du skapar pushar eller förfrågningar riktar du in dig på en specifik arbetsyta genom att skicka workspace_id parametern med arbetsytans id.

Obs: Denna parameter hette tidigare account_id och bytt namn till workspace_id. Arvet från account_id namnet accepteras fortfarande för bakåtkompatibilitet.

Som standard har du en arbetsyta. På pwpush.com kan du skapa ytterligare arbetsytor för ditt team eller din organisation. I Self-Hosted Pro skapas endast en arbetsyta för dig.

Lista arbetsytor med GET /api/v2/workspaces eller motsvarande GET /api/v1/workspaces. I API v1 och v2 är de äldre sökvägarna GET /api/v1/accounts och GET /api/v2/accounts returnerar samma JSON.

GET /api/v2/workspaces

Legacy alias: GET /api/v2/accounts (identiskt svar).

Returnerar alla arbetsytor som den autentiserade användaren tillhör. Använd varje objekts id som workspace_id när du skapar pushar eller förfrågningar.

Exempel på begäran

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

Exempel på svar

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

Svarsfält

Fält	Typ	Beskrivning
`id`	integer	Numeriskt id för arbetsytan. Skicka detta värde som `workspace_id` när du skapar pushar eller förfrågningar.
`name`	string	Visningsnamn för arbetsytan
`created_at`	string (ISO 8601)	När arbetsytan skapades
`updated_at`	string (ISO 8601)	När arbetsytan senast uppdaterades

Rikta in en arbetsyta

När du skapar pushes eller requests kan du välja att skicka workspace_id för att associera resursen med en viss arbetsyta. Om den utelämnas skapas resursen i din standardarbetsyta.

Obs! Denna parameter hette tidigare account_id och bytt namn till workspace_id. Arvet från account_id accepteras fortfarande för bakåtkompatibilitet, men nya integrationer bör använda workspace_id.

Viktigt: Du får bara använda id:n för arbetsytor som du tillhör. Om du använder en annan arbetsytas id returneras 401 Unauthorized.