Password Pusher API v2

BETA

Uitgebreide REST API-documentatie voor integratie Password Pusher in uw toepassingen

Bètabericht: API v2 is momenteel in bèta. Hoewel we alles in het werk hebben gesteld om stabiliteit te garanderen, kunnen er vóór de definitieve release nog wijzigingen worden doorgevoerd. We zijn blij met je feedback!

Werkplekken

Workspaces zijn de manier waarop Password Pusher pushes en aanvragen organiseert voor teams en individuen. Een gebruiker kan tot meerdere workspaces behoren. Wanneer u pushes of verzoeken aanmaakt, richt u zich op een specifieke werkruimte door de workspace_id parameter met de id van de werkruimte.

Opmerking: Deze parameter heette voorheen account_id en hernoemd naar workspace_id. De erfenis account_id naam wordt nog steeds geaccepteerd voor achterwaartse compatibiliteit.

Standaard heb je één werkruimte. Op pwpush.com kun je extra werkruimten maken voor je team of organisatie. In Self-Hosted Pro wordt er maar één werkruimte voor je aangemaakt.

Werkruimten weergeven met GET /api/v2/workspaces of gelijkwaardig GET /api/v1/workspaces. In API v1 en v2 zijn de bestaande paden GET /api/v1/accounts en GET /api/v2/accounts geven dezelfde JSON terug.

GET /api/v2/workspaces

Legacy alias: GET /api/v2/accounts (identiek antwoord).

Retourneert elke werkruimte waartoe de geverifieerde gebruiker behoort. Gebruik de id als workspace_id bij het maken van pushes of verzoeken.

Voorbeeld verzoek

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

Voorbeeld Response

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

Antwoordvelden

Veld	Type	Beschrijving
`id`	integer	Numeriek id van de werkruimte. Geef deze waarde door als `workspace_id` bij het maken van pushes of verzoeken.
`name`	string	Weergavenaam van de werkruimte
`created_at`	string (ISO 8601)	Wanneer de werkruimte is gemaakt
`updated_at`	string (ISO 8601)	Wanneer de werkruimte voor het laatst is bijgewerkt

Een werkruimte richten

Bij het maken van pushes of verzoeken kun je optioneel het volgende doorgeven workspace_id om de bron aan een specifieke werkruimte te koppelen. Als dit wordt weggelaten, wordt de bron aangemaakt in je standaard werkruimte.

Opmerking: Deze parameter heette voorheen account_id en hernoemd naar workspace_id. De erfenis account_id naam wordt nog steeds geaccepteerd voor achterwaartse compatibiliteit, maar nieuwe integraties moeten gebruik maken van workspace_id.

Belangrijk: Je mag alleen werkruimte-id's gebruiken waartoe je behoort. Als je de id van een andere werkruimte gebruikt 401 Unauthorized.