Password Pusher API v2

BETA

Omfattende REST API-dokumentation til integration Password Pusher ind i dine applikationer

Beta-meddelelse: API v2 er i øjeblikket i beta. Vi har gjort alt for at sikre stabilitet, men der kan forekomme ændringer inden den endelige udgivelse. Vi glæder os over din feedback!

Arbejdspladser

Workspaces er den måde, Password Pusher organiserer pushes og anmodninger til teams og enkeltpersoner. En bruger kan tilhøre flere arbejdsområder. Når du opretter pushes eller anmodninger, skal du målrette mod et specifikt arbejdsområde ved at sende workspace_id parameter med arbejdsområdets id.

Bemærk: Denne parameter hed tidligere account_idog omdøbt til workspace_id. Arven account_id navn accepteres stadig af hensyn til bagudkompatibilitet.

Som standard har du ét arbejdsområde. På pwpush.com kan du oprette flere arbejdsområder til dit team eller din organisation. I Self-Hosted Pro oprettes der kun ét arbejdsområde til dig.

Vis arbejdsområder med GET /api/v2/workspaces eller tilsvarende GET /api/v1/workspaces. I API v1 og v2 er de gamle stier GET /api/v1/accounts og GET /api/v2/accounts returnerer den samme JSON.

GET /api/v2/workspaces

Ældre alias: GET /api/v2/accounts (identisk svar).

Returnerer alle arbejdsområder, som den godkendte bruger tilhører. Brug hvert elements id som workspace_id når du opretter pushes eller requests.

Eksempel på anmodning

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

Eksempel 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"
  }
]

Svarfelter

Felt	Type	Beskrivelse
`id`	integer	Numerisk id for arbejdsområdet. Send denne værdi som `workspace_id` når du opretter pushes eller requests.
`name`	string	Visningsnavn for arbejdsområdet
`created_at`	string (ISO 8601)	Da arbejdsområdet blev oprettet
`updated_at`	string (ISO 8601)	Hvornår arbejdsområdet sidst blev opdateret

Målretning af et arbejdsområde

Når du opretter pushes eller requests, kan du eventuelt sende workspace_id for at knytte ressourcen til et bestemt arbejdsområde. Hvis det udelades, oprettes ressourcen i dit standardarbejdsområde.

Bemærk: Denne parameter hed tidligere account_idog omdøbt til workspace_id. Arven account_id navn accepteres stadig af hensyn til bagudkompatibilitet, men nye integrationer bør bruge workspace_id.

Det er vigtigt: Du må kun bruge arbejdsområde-id'er, som du selv tilhører. Brug af et andet arbejdsområdes id returnerer 401 Unauthorized.