Password Pusher API v2

BETA

Documentación completa de la API REST para la integración Password Pusher en sus aplicaciones

Aviso Beta: La API v2 está actualmente en fase beta. Aunque hemos hecho todo lo posible para garantizar la estabilidad, es posible que haya cambios de última hora antes de la versión final. Agradecemos sus comentarios

Espacios de trabajo

Los espacios de trabajo son la forma en que Password Pusher organiza las solicitudes y peticiones de equipos e individuos. Un usuario puede pertenecer a varios espacios de trabajo. Al crear envíos o solicitudes, diríjase a un espacio de trabajo específico pasando el parámetro workspace_id con el identificador del espacio de trabajo.

Nota: Este parámetro se denominaba anteriormente account_id y renombrado a workspace_id. El legado account_id por compatibilidad con versiones anteriores.

Por defecto, dispones de un espacio de trabajo. En pwpush.com, puedes crear espacios de trabajo adicionales para tu equipo u organización. En Self-Hosted Pro, solo se crea un espacio de trabajo para ti.

Listar espacios de trabajo con GET /api/v2/workspaces o equivalente GET /api/v1/workspaces. En API v1 y v2, las rutas heredadas GET /api/v1/accounts y GET /api/v2/accounts devuelven el mismo JSON.

GET /api/v2/workspaces

Alias heredado: GET /api/v2/accounts (respuesta idéntica).

Devuelve todos los espacios de trabajo a los que pertenece el usuario autenticado. Utiliza el id como workspace_id al crear solicitudes o peticiones.

Ejemplo de solicitud

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

Ejemplo de respuesta

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

Campos de respuesta

Campo	Tipo	Descripción
`id`	integer	Id numérico del espacio de trabajo. Pase este valor como `workspace_id` al crear solicitudes o peticiones.
`name`	string	Nombre para mostrar del espacio de trabajo
`created_at`	string (ISO 8601)	Cuando se creó el espacio de trabajo
`updated_at`	string (ISO 8601)	Fecha de la última actualización del espacio de trabajo

Seleccionar un espacio de trabajo

Al crear envíos o solicitudes, puede pasar opcionalmente workspace_id para asociar el recurso a un espacio de trabajo específico. Si se omite, el recurso se crea en su espacio de trabajo predeterminado.

Nota: Este parámetro se denominaba anteriormente account_id y renombrado a workspace_id. El legado account_id por compatibilidad con versiones anteriores, pero las nuevas integraciones deben utilizar workspace_id.

Importante: Sólo puede utilizar identificadores de espacios de trabajo a los que pertenezca. El uso del id de otro espacio de trabajo devuelve 401 Unauthorized.