Password Pusher API v2

BETA

Umfassende REST-API-Dokumentation für die Integration von Password Pusher in Ihre Anwendungen

Beta-Bekanntmachung: API v2 befindet sich derzeit in der Betaphase. Wir haben alles getan, um die Stabilität zu gewährleisten, aber bis zur endgültigen Veröffentlichung kann es noch zu Änderungen kommen. Wir freuen uns über Ihr Feedback!

Arbeitsbereiche

Arbeitsbereiche sind die Art und Weise, wie Password Pusher Pushs und Anfragen für Teams und Einzelpersonen organisiert. Ein Benutzer kann zu mehreren Arbeitsbereichen gehören. Wenn Sie Pushs oder Anfragen erstellen, zielen Sie auf einen bestimmten Arbeitsbereich ab, indem Sie die workspace_id mit der Arbeitsbereichs-ID.

Hinweis: Dieser Parameter hieß früher account_idund umbenannt in workspace_id. Das Vermächtnis account_id name wird aus Gründen der Abwärtskompatibilität weiterhin akzeptiert.

Standardmäßig haben Sie einen Arbeitsbereich. Auf pwpush.com können Sie zusätzliche Arbeitsbereiche für Ihr Team oder Ihre Organisation erstellen. In Self-Hosted Pro wird nur ein Arbeitsbereich für Sie erstellt.

Arbeitsbereiche auflisten mit GET /api/v2/workspaces oder das Äquivalent GET /api/v1/workspaces. In API v1 und v2 sind die alten Pfade GET /api/v1/accounts und GET /api/v2/accounts geben das gleiche JSON zurück.

GET /api/v2/workspaces

Vererbter Alias: GET /api/v2/accounts (identische Antwort).

Gibt jeden Arbeitsbereich zurück, zu dem der authentifizierte Benutzer gehört. Verwenden Sie für jedes Element die id als workspace_id bei der Erstellung von Pushs oder Anfragen.

Beispiel-Anfrage

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

Beispiel Antwort

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

Antwortfelder

Feld	Typ	Beschreibung
`id`	integer	Numerische ID des Arbeitsbereichs. Übergeben Sie diesen Wert als `workspace_id` bei der Erstellung von Pushs oder Anfragen.
`name`	string	Anzeigename des Arbeitsbereichs
`created_at`	string (ISO 8601)	Wenn der Arbeitsbereich erstellt wurde
`updated_at`	string (ISO 8601)	Wann der Arbeitsbereich zuletzt aktualisiert wurde

Einen Arbeitsbereich anvisieren

Bei der Erstellung von Pushes oder Requests können Sie optional workspace_id um die Ressource mit einem bestimmten Arbeitsbereich zu verknüpfen. Wird dies nicht angegeben, wird die Ressource in Ihrem Standardarbeitsbereich erstellt.

Anmerkung: Dieser Parameter wurde früher als account_idund umbenannt in workspace_id. Das Vermächtnis account_id wird aus Gründen der Abwärtskompatibilität weiterhin akzeptiert, aber neue Integrationen sollten den Namen workspace_id.

Das ist wichtig: Sie dürfen nur Arbeitsbereichs-IDs verwenden, denen Sie selbst angehören. Die Verwendung der ID eines anderen Arbeitsbereichs ergibt 401 Unauthorized.