Password Pusher API v2

BÊTA

Documentation complète de l'API REST pour l'intégration Password Pusher dans vos applications

Avis bêta : L'API v2 est actuellement en version bêta. Bien que nous ayons fait tous les efforts possibles pour en assurer la stabilité, il est possible que des changements radicaux soient apportés avant la sortie de la version finale. N'hésitez pas à nous faire part de vos commentaires !

Espaces de travail

Les espaces de travail sont la façon dont Password Pusher organise les poussées et les demandes pour les équipes et les individus. Un utilisateur peut appartenir à plusieurs espaces de travail. Lors de la création de poussées ou de demandes, ciblez un espace de travail spécifique en passant l'attribut workspace_id avec l'identifiant de l'espace de travail.

Note : Ce paramètre s'appelait auparavant account_id et renommé en workspace_id. L'héritage account_id est toujours accepté pour des raisons de compatibilité ascendante.

Par défaut, vous disposez d'un espace de travail. Sur pwpush.com, vous pouvez créer des espaces de travail supplémentaires pour votre équipe ou votre organisation. Dans Self-Hosted Pro, un seul espace de travail est créé pour vous.

Lister les espaces de travail avec GET /api/v2/workspaces ou l'équivalent GET /api/v1/workspaces. Dans les API v1 et v2, les anciens chemins d'accès GET /api/v1/accounts et GET /api/v2/accounts renvoient le même JSON.

GET /api/v2/workspaces

Alias d'héritage : GET /api/v2/accounts (réponse identique).

Renvoie tous les espaces de travail auxquels l'utilisateur authentifié appartient. Utilisez la valeur id comme workspace_id lors de la création de poussées ou de demandes.

Exemple de demande

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

Exemple de réponse

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

Champs de réponse

Champ d'application	Taper	Description
`id`	integer	Identifiant numérique de l'espace de travail. Transmettre cette valeur en tant que `workspace_id` lors de la création de poussées ou de demandes.
`name`	string	Nom d'affichage de l'espace de travail
`created_at`	string (ISO 8601)	Lors de la création de l'espace de travail
`updated_at`	string (ISO 8601)	Date de la dernière mise à jour de l'espace de travail

Cibler un espace de travail

Lors de la création d'une poussée ou d'une demande, vous pouvez facultativement passer le code workspace_id pour associer la ressource à un espace de travail spécifique. En cas d'omission, la ressource est créée dans votre espace de travail par défaut.

Remarque : Ce paramètre s'appelait auparavant account_id et renommé en workspace_id. L'héritage account_id est toujours accepté pour des raisons de compatibilité ascendante, mais les nouvelles intégrations doivent utiliser le nom workspace_id.

Important : Vous ne pouvez utiliser que les identifiants des espaces de travail auxquels vous appartenez. L'utilisation de l'identifiant d'un autre espace de travail renvoie 401 Unauthorized.