Password Pusher API v2

BETAVERSJON

Omfattende REST API-dokumentasjon for integrering Password Pusher inn i applikasjonene dine

Beta-varsel: API v2 er for øyeblikket i betaversjon. Vi har gjort vårt ytterste for å sikre stabilitet, men det kan forekomme endringer før den endelige utgivelsen. Vi tar gjerne imot tilbakemeldinger!

Arbeidsområder

Arbeidsområder er hvordan Password Pusher organiserer push- og forespørsler for team og enkeltpersoner. En bruker kan tilhøre flere arbeidsområder. Når du oppretter push eller forespørsler, målretter du mot et bestemt arbeidsområde ved å sende workspace_id parameteren med id-en til arbeidsområdet.

Merk: Denne parameteren ble tidligere kalt account_id og omdøpt til workspace_id. Arven account_id navnet godtas fortsatt av hensyn til bakoverkompatibilitet. Arbeidsområde-ID-er returneres som strenger med prefiks (for eksempel acct_oxQdpMWVm); rene numeriske ID-er godtas fortsatt som inndata.

Som standard har du ett arbeidsområde. På pwpush.com kan du opprette flere arbeidsområder for teamet eller organisasjonen din. I Self-Hosted Pro opprettes det bare ett arbeidsområde for deg.

Liste over arbeidsområder med GET /api/v2/workspaces eller tilsvarende GET /api/v1/workspaces. I API v1 og v2 er de eldre banene GET /api/v1/accounts og GET /api/v2/accounts returnerer samme JSON.

GET /api/v2/workspaces

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

Returnerer alle arbeidsområder den autentiserte brukeren tilhører. Bruk hvert elements id som workspace_id når du oppretter push eller forespørsler.

Eksempel på forespørsel

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

Eksempel på svar

[
  {
    "id": "acct_oxQdpMWVm",
    "name": "My Personal Workspace",
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z"
  },
  {
    "id": "acct_k9Lm2nPqR",
    "name": "Acme Corporation",
    "created_at": "2023-10-20T08:00:00.000Z",
    "updated_at": "2023-10-20T08:00:00.000Z"
  }
]

Svarfelt

Felt	Type	Beskrivelse
`id`	string	Arbeidsområde-ID med prefiks (for eksempel `acct_oxQdpMWVm`). Overfør denne verdien som `workspace_id` når du oppretter push-meldinger eller forespørsler. Eldre numeriske ID-er godtas fortsatt som inndata av hensyn til bakoverkompatibilitet.
`name`	string	Visningsnavn på arbeidsområdet
`created_at`	string (ISO 8601)	Når arbeidsområdet ble opprettet
`updated_at`	string (ISO 8601)	Når arbeidsområdet sist ble oppdatert

Målrette et arbeidsområde

Når du oppretter push eller forespørsler, kan du eventuelt sende workspace_id for å knytte ressursen til et bestemt arbeidsområde. Hvis du utelater dette, opprettes ressursen i standardarbeidsområdet ditt.

Merk: Denne parameteren ble tidligere kalt account_id og omdøpt til workspace_id. Arven account_id navn er fortsatt akseptert for bakoverkompatibilitet, men nye integrasjoner bør bruke workspace_id.

Det er viktig: Du kan bare bruke arbeidsområde-ID-er som du selv tilhører. Bruk av et annet arbeidsområdes id returnerer 401 Unauthorized.