Password Pusher API v2

BETA

Documentazione completa dell'API REST per l'integrazione Password Pusher nelle vostre applicazioni

Avviso Beta: L'API v2 è attualmente in fase beta. Abbiamo fatto ogni sforzo per garantire la stabilità, ma è possibile che vengano apportate delle modifiche prima del rilascio finale. Siamo lieti di ricevere il vostro feedback!

Spazi di lavoro

Gli spazi di lavoro sono il modo in cui Password Pusher organizza i push e le richieste per i team e gli individui. Un utente può appartenere a più spazi di lavoro. Quando si creano push o richieste, si può puntare a un workspace specifico passando l'opzione workspace_id con l'id dello spazio di lavoro.

Nota: questo parametro era precedentemente denominato account_id e rinominato in workspace_id. L'eredità account_id è ancora accettato per la retrocompatibilità.

Per impostazione predefinita, si dispone di un unico spazio di lavoro. Su pwpush.com, è possibile creare altri spazi di lavoro per il proprio team o organizzazione. In Self-Hosted Pro, viene creato un solo spazio di lavoro per l'utente.

Elencare gli spazi di lavoro con GET /api/v2/workspaces o l'equivalente GET /api/v1/workspaces. Nelle API v1 e v2, i percorsi tradizionali GET /api/v1/accounts e GET /api/v2/accounts restituiscono lo stesso JSON.

GET /api/v2/workspaces

Alias legacy: GET /api/v2/accounts (risposta identica).

Restituisce tutti gli spazi di lavoro a cui appartiene l'utente autenticato. Utilizzare l'elemento id come workspace_id quando si creano push o richieste.

Esempio di richiesta

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

Esempio di risposta

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

Campi di risposta

Campo	Tipo	Descrizione
`id`	integer	Id numerico dell'area di lavoro. Passare questo valore come `workspace_id` quando si creano push o richieste.
`name`	string	Nome di visualizzazione dell'area di lavoro
`created_at`	string (ISO 8601)	Quando l'area di lavoro è stata creata
`updated_at`	string (ISO 8601)	Quando l'area di lavoro è stata aggiornata l'ultima volta

Definizione di un'area di lavoro

Quando si creano push o richieste, si può passare facoltativamente il metodo workspace_id per associare la risorsa a uno specifico spazio di lavoro. Se si omette, la risorsa viene creata nell'area di lavoro predefinita.

Nota: Questo parametro era precedentemente denominato account_id e rinominato in workspace_id. L'eredità account_id è ancora accettato per la retrocompatibilità, ma le nuove integrazioni dovrebbero utilizzare il nome workspace_id.

Importante: Si possono usare solo gli id degli spazi di lavoro a cui si appartiene. L'uso dell'id di un altro spazio di lavoro restituisce 401 Unauthorized.