Password Pusher API v2

BETA

Documentação abrangente da API REST para integração Password Pusher em seus aplicativos

Aviso de Beta: A API v2 está atualmente em versão beta. Embora tenhamos feito todos os esforços para garantir a estabilidade, pode haver mudanças significativas antes do lançamento final. Seus comentários são bem-vindos!

Espaços de trabalho

Os espaços de trabalho são a forma como o Password Pusher organiza os envios e as solicitações para equipes e indivíduos. Um usuário pode pertencer a vários espaços de trabalho. Ao criar pushes ou solicitações, direcione um espaço de trabalho específico passando o parâmetro workspace_id com o ID do espaço de trabalho.

Observação: esse parâmetro era anteriormente denominado account_id e renomeado para workspace_id. O legado account_id ainda é aceito para compatibilidade com versões anteriores.

Por padrão, você tem um espaço de trabalho. No pwpush.com, é possível criar espaços de trabalho adicionais para sua equipe ou organização. No Self-Hosted Pro, apenas um espaço de trabalho é criado para você.

Listar espaços de trabalho com GET /api/v2/workspaces ou o equivalente GET /api/v1/workspaces. Na API v1 e v2, os caminhos legados GET /api/v1/accounts e GET /api/v2/accounts retornam o mesmo JSON.

GET /api/v2/workspaces

Apelido de legado: GET /api/v2/accounts (resposta idêntica).

Retorna todos os espaços de trabalho aos quais o usuário autenticado pertence. Use a variável id como workspace_id ao criar pushes ou solicitações.

Exemplo de solicitação

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

Exemplo 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"
  }
]

Campos de resposta

Campo	Tipo	Descrição
`id`	integer	ID numérico do espaço de trabalho. Passe esse valor como `workspace_id` ao criar pushes ou solicitações.
`name`	string	Nome de exibição do espaço de trabalho
`created_at`	string (ISO 8601)	Quando o espaço de trabalho foi criado
`updated_at`	string (ISO 8601)	Quando o espaço de trabalho foi atualizado pela última vez

Direcionamento de um espaço de trabalho

Ao criar pushes ou solicitações, você pode, opcionalmente, passar workspace_id para associar o recurso a um espaço de trabalho específico. Se omitido, o recurso será criado em seu espaço de trabalho padrão.

Observação: Esse parâmetro era anteriormente denominado account_id e renomeado para workspace_id. O legado account_id ainda é aceito para compatibilidade com versões anteriores, mas as novas integrações devem usar workspace_id.

Importante: Você só pode usar ids de workspaces aos quais você pertence. O uso do id de outro espaço de trabalho retorna 401 Unauthorized.