Password Pusher API versió 2

BETA

Documentació completa de l'API REST per a la integració Password Pusher a les vostres aplicacions

Avís beta: L'API v2 està actualment en versió beta. Tot i que hem fet tot el possible per garantir l'estabilitat, és possible que hi hagi canvis importants abans del llançament final. Agraïm els vostres comentaris!

Espais de treball

Els espais de treball són la manera com Password Pusher organitza les push i les sol·licituds per a equips i individus. Un usuari pot pertànyer a diversos espais de treball. Quan creeu push o sol·licituds, dirigiu-vos a un espai de treball específic passant-hi el workspace_id paràmetre amb l'ID de l'espai de treball.

Nota: Aquest paràmetre s'anomenava anteriorment account_id i rebatejat com a workspace_idEl llegat account_id El nom encara s'accepta per compatibilitat amb versions anteriors.

Per defecte, teniu un espai de treball. A pwpush.com, podeu crear espais de treball addicionals per al vostre equip o organització. A Self-Hosted Pro, només es crea un espai de treball per a vosaltres.

Llistar espais de treball amb GET /api/v2/workspaces o l'equivalent GET /api/v1/workspacesA l'API v1 i v2, els camins antics GET /api/v1/accounts i GET /api/v2/accounts retorna el mateix JSON.

GET /api/v2/workspaces

Àlies antic: GET /api/v2/accounts (resposta idèntica).

Retorna tots els espais de treball als quals pertany l'usuari autenticat. Utilitza cada element id com workspace_id en crear push o sol·licituds.

Exemple de sol·licitud

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

Exemple de resposta

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

Camps de resposta

Camp	Tipus	Descripció
`id`	integer	Identificador numèric de l'espai de treball. Passa aquest valor com a `workspace_id` en crear push o sol·licituds.
`name`	string	Nom per mostrar de l'espai de treball
`created_at`	string (ISO 8601)	Quan es va crear l'espai de treball
`updated_at`	string (ISO 8601)	Quan es va actualitzar l'espai de treball per última vegada

Orientació a un espai de treball

Quan creeu push o sol·licituds, podeu passar opcionalment workspace_id per associar el recurs amb un espai de treball específic. Si s'omet, el recurs es crea a l'espai de treball predeterminat.

Nota: Aquest paràmetre s'anomenava anteriorment account_id i rebatejat com a workspace_idEl llegat account_id El nom encara s'accepta per compatibilitat amb versions anteriors, però les noves integracions haurien d'utilitzar-lo workspace_id.

Important: Només podeu utilitzar els identificadors d'espai de treball als quals pertanyeu. L'ús de l'identificador d'un altre espai de treball retorna 401 Unauthorized.