Password Pusher API v2

BETA

Komplexní dokumentace rozhraní REST API pro integraci Password Pusher do vašich aplikací

Oznámení o betaverzi: Rozhraní API v2 je v současné době ve fázi beta. Přestože jsme vynaložili veškeré úsilí, abychom zajistili stabilitu, může dojít před vydáním finální verze ke zlomovým změnám. Uvítáme vaši zpětnou vazbu!

Pracovní prostory

Pracovní prostory jsou způsobem, jakým aplikace Password Pusher organizuje odesílání a požadavky pro týmy a jednotlivce. Uživatel může patřit do více pracovních prostorů. Při vytváření pushů nebo požadavků se zaměřte na konkrétní pracovní prostor předáním parametru workspace_id parametr s id pracovního prostoru.

Poznámka: Tento parametr se dříve jmenoval account_id a přejmenován na workspace_id. Dědictví account_id název je stále akceptován kvůli zpětné kompatibilitě.

Ve výchozím nastavení máte k dispozici jeden pracovní prostor. Na webu pwpush.com můžete vytvořit další pracovní prostory pro svůj tým nebo organizaci. Ve službě Self-Hosted Pro je pro vás vytvořen pouze jeden pracovní prostor.

Seznam pracovních prostorů s GET /api/v2/workspaces nebo ekvivalentní GET /api/v1/workspaces. V rozhraní API v1 a v2 jsou starší cesty GET /api/v1/accounts a GET /api/v2/accounts vrátí stejný JSON.

GET /api/v2/workspaces

Dědictví alias: GET /api/v2/accounts (totožná odpověď).

Vrátí všechny pracovní prostory, do kterých patří ověřený uživatel. Použijte položku id jako workspace_id při vytváření požadavků nebo odesílání.

Příklad požadavku

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říklad reakce

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

Pole odpovědí

Pole	Typ	Popis
`id`	integer	Číselné ID pracovního prostoru. Tuto hodnotu předejte jako `workspace_id` při vytváření požadavků nebo odesílání.
`name`	string	Zobrazení názvu pracovního prostoru
`created_at`	string (ISO 8601)	Při vytvoření pracovního prostoru
`updated_at`	string (ISO 8601)	Kdy byl pracovní prostor naposledy aktualizován

Zaměření pracovního prostoru

Při vytváření požadavků nebo odesílání můžete volitelně předat workspace_id přiřadit prostředek ke konkrétnímu pracovnímu prostoru. Pokud je vynecháno, bude prostředek vytvořen ve výchozím pracovním prostoru.

Poznámka: Tento parametr se dříve jmenoval account_id a přejmenován na workspace_id. Dědictví account_id název je stále akceptován kvůli zpětné kompatibilitě, ale nové integrace by měly používat název workspace_id.

Důležité: Můžete používat pouze id pracovního prostoru, ke kterému patříte. Použití id jiného pracovního prostoru vrátí 401 Unauthorized.