Password Pusher API v2

BETA

Documentație cuprinzătoare REST API pentru integrare Password Pusher în aplicațiile dvs

Aviz Beta: API v2 este în prezent în versiune beta. Deși am depus toate eforturile pentru a asigura stabilitatea, este posibil să existe modificări de ultimă oră înainte de lansarea finală. Feedback-ul dvs. este binevenit!

Spații de lucru

Spațiile de lucru reprezintă modul în care Password Pusher organizează push-urile și solicitările pentru echipe și persoane. Un utilizator poate aparține mai multor spații de lucru. Atunci când creați push-uri sau cereri, vizați un anumit spațiu de lucru, trecând workspace_id cu id-ul spațiului de lucru.

Notă: Acest parametru a fost denumit anterior account_id și redenumit în workspace_id. Moștenirea account_id numele este încă acceptat din motive de compatibilitate cu versiunile anterioare. ID-urile spațiilor de lucru sunt returnate sub formă de șiruri de caractere cu prefix (de exemplu acct_oxQdpMWVm); ID-urile numerice brute sunt în continuare acceptate ca date de intrare.

În mod implicit, aveți un singur spațiu de lucru. Pe pwpush.com, puteți crea spații de lucru suplimentare pentru echipa sau organizația dvs. În Self-Hosted Pro, este creat un singur spațiu de lucru pentru dvs.

Listați spațiile de lucru cu GET /api/v2/workspaces sau echivalent GET /api/v1/workspaces. În API v1 și v2, căile tradiționale GET /api/v1/accounts și GET /api/v2/accounts returnează același JSON.

GET /api/v2/workspaces

Pseudonim legendar: GET /api/v2/accounts (răspuns identic).

Returnează fiecare spațiu de lucru din care face parte utilizatorul autentificat. Utilizați fiecare element id ca workspace_id atunci când creați push-uri sau cereri.

Exemplu de cerere

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

Exemplu de răspuns

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

Câmpuri de răspuns

Câmp	Tip	Descriere
`id`	string	ID-ul spațiului de lucru cu prefix (de exemplu `acct_oxQdpMWVm`). Transmite această valoare ca `workspace_id` la crearea de push-uri sau solicitări. ID-urile numerice vechi sunt încă acceptate ca date de intrare, din motive de compatibilitate cu versiunile anterioare.
`name`	string	Numele de afișare al spațiului de lucru
`created_at`	string (ISO 8601)	Când a fost creat spațiul de lucru
`updated_at`	string (ISO 8601)	Când a fost actualizat ultima dată spațiul de lucru

Direcționarea unui spațiu de lucru

Atunci când creați push-uri sau cereri, puteți trece opțional workspace_id pentru a asocia resursa cu un anumit spațiu de lucru. Dacă este omisă, resursa este creată în spațiul de lucru implicit.

Notă: Acest parametru a fost denumit anterior account_id și redenumit în workspace_id. Moștenirea account_id este în continuare acceptat pentru compatibilitate cu versiunile anterioare, dar noile integrări ar trebui să utilizeze workspace_id.

Important: Puteți utiliza numai id-urile spațiului de lucru din care faceți parte. Utilizarea id-ului unui alt spațiu de lucru returnează 401 Unauthorized.