Password Pusher API v2

BETA

Komplexná dokumentácia REST API na integráciu Password Pusher do vašich aplikácií

Oznámenie o beta verzii: Rozhranie API v2 je v súčasnosti vo fáze beta. Hoci sme vynaložili maximálne úsilie na zabezpečenie stability, pred konečným vydaním sa môžu vyskytnúť zmeny. Uvítame vašu spätnú väzbu!

Pracovné priestory

Pracovné priestory sú spôsob, akým Password Pusher organizuje tlačenia a požiadavky pre tímy a jednotlivcov. Používateľ môže patriť do viacerých pracovných priestorov. Pri vytváraní odoslaní alebo požiadaviek sa zamerajte na konkrétny pracovný priestor odovzdaním príkazu workspace_id parameter s identifikátorom pracovného priestoru.

Poznámka: Tento parameter sa predtým volal account_id a premenovaný na workspace_id. Dedičstvo account_id názov je stále akceptovaný kvôli spätnej kompatibilite.

V predvolenom nastavení máte k dispozícii jeden pracovný priestor. Na stránke pwpush.com môžete vytvoriť ďalšie pracovné priestory pre svoj tím alebo organizáciu. V službe Self-Hosted Pro je pre vás vytvorený len jeden pracovný priestor.

Zoznam pracovných priestorov s GET /api/v2/workspaces alebo ekvivalent GET /api/v1/workspaces. V rozhraniach API v1 a v2 sú staršie cesty GET /api/v1/accounts a GET /api/v2/accounts vrátiť rovnaký JSON.

GET /api/v2/workspaces

Dedičný alias: GET /api/v2/accounts (rovnaká odpoveď).

Vráti každý pracovný priestor, do ktorého patrí overený používateľ. Použite položku každej položky id ako workspace_id pri vytváraní tlačidiel alebo požiadaviek.

Príklad žiadosti

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

Príklad reakcie

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

Polia odpovede

Pole	Typ	Popis
`id`	integer	Číselné ID pracovného priestoru. Túto hodnotu odovzdajte ako `workspace_id` pri vytváraní tlačidiel alebo požiadaviek.
`name`	string	Zobrazenie názvu pracovného priestoru
`created_at`	string (ISO 8601)	Pri vytvorení pracovného priestoru
`updated_at`	string (ISO 8601)	Kedy bol pracovný priestor naposledy aktualizovaný

Zameranie pracovného priestoru

Pri vytváraní tlačových hlásení alebo požiadaviek môžete voliteľne odovzdať workspace_id na priradenie prostriedku ku konkrétnemu pracovnému priestoru. Ak sa vynechá, prostriedok sa vytvorí vo vašom predvolenom pracovnom priestore.

Poznámka: Tento parameter sa predtým nazýval account_id a premenovaný na workspace_id. Dedičstvo account_id názov je stále akceptovaný kvôli spätnej kompatibilite, ale nové integrácie by mali používať workspace_id.

Dôležité: Môžete používať len identifikátory pracovných priestorov, ktoré vám patria. Použitie id iného pracovného priestoru vráti 401 Unauthorized.