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!

Empurra

Os pushs permitem a transmissão segura e unidirecional de dados confidenciais para os destinatários. Crie um push com um URL secreto contendo texto, arquivos, códigos QR ou URLs e compartilhe-o com qualquer pessoa, tudo sem expor dados confidenciais em e-mails, bate-papos ou registros.

Perfeito para a integração de funcionários, envio de credenciais de contas, transmissão de documentos confidenciais ou compartilhamento de qualquer informação sensível. Os pushs expiram automaticamente após uma duração ou número de visualizações especificado, e o rastreamento completo do ciclo de vida está disponível nos registros de auditoria de cada push.

POST /api/v2/pushes

Cria um novo push com a carga útil fornecida.

Corpo da solicitação (JSON)

{
  "push": {
    "payload": "secret_password_123",
    "expire_after_duration": 6,
    "expire_after_views": 5,
    "passphrase": "optional_passphrase",
    "name": "Database Credentials",
    "note": "Internal note",
    "deletable_by_viewer": true,
    "retrieval_step": true,
    "kind": "text"
  },
  "account_id": 123
}

Corpo da solicitação com arquivos (multipart/form-data)

curl -X POST https://eu.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "push[payload]=secret_password_123" \
  -F "push[expire_after_duration]=6" \
  -F "push[expire_after_views]=5" \
  -F "push[name]=Database Credentials" \
  -F "push[files][]=@/path/to/file1.pdf" \
  -F "push[files][]=@/path/to/file2.txt"

Observação: Ao anexar arquivos, use multipart/form-data formato e conjunto kind: "file". Vários arquivos podem ser anexados usando push[files][].

Parâmetros

Parâmetro	Tipo	Descrição
`payload` requeridos	string	O texto secreto a ser compartilhado
`expire_after_duration` opcional	integer (0-17)	Duration enum (0-17)
`expire_after_views` opcional	integer (1-100)	Número de visualizações antes da expiração
`passphrase` opcional	string	Exigir senha para visualizar
`name` opcional	string	Um nome para o impulso
`note` opcional	string	Nota interna (visível apenas para o criador)
`deletable_by_viewer` opcional	boolean	Permitir que os espectadores excluam o push
`retrieval_step` opcional	boolean	Exigir uma etapa extra para recuperar
`kind` opcional	string	Tipo: "text", "file", "url" ou "qr" (o padrão é "text")
`notify_emails_to` opcional	string	Endereços de e-mail a serem notificados quando um push for criado (separados por vírgulas)
`notify_emails_to_locale` opcional	string	Localidade (idioma) para enviar as notificações por e-mail
`account_id` opcional	integer	A ID da conta à qual associar o envio (para usuários com várias contas)

Valores de duração para `expire_after_duration`

0: 15 minutos

1: 30 minutos

2: 45 minutos

3: 1 hora

4: 6 horas

5: 12 horas

6: 1 dia

7: 2 dias

8: 3 dias

9: 4 dias

10: 5 dias

11: 6 dias

12: 1 semana

13: 2 semanas

14: 3 semanas

15: 1 mês

16: 2 meses

17: 3 meses

Campos de resposta

Os campos a seguir são retornados na resposta ao criar um push. Observação: a carga útil e os arquivos NÃO são retornados na criação; eles só estão disponíveis ao recuperar um envio por GET.

Campo	Tipo	Exemplo	Descrição
account_id	integer or null	1	ID da conta do proprietário
created_at	string	"2025-02-17T10:00:00.000Z"	Tempo de criação da ISO 8601
days_remaining	integer	1	Descontinuada Dias inteiros restantes (0 quando < 1 dia); preferir expires_at / expires_in
deletable_by_viewer	boolean	true	Se o destinatário pode excluir o envio
deleted	boolean	false	Se o push foi explicitamente excluído
expire_after_days	integer	1	Descontinuada Dias aproximados (derivados da duração)
expire_after_duration	integer	6	Duration enum (0-17); consulte a tabela acima
expire_after_views	integer	5	Máximo de visualizações antes da expiração
expired	boolean	false	Se o push expirou
expired_on	string or null	null	ISO 8601 quando o push expirou; nulo se não tiver expirado
expires_at	string or null	"2025-02-18T10:00:00.000Z"	Hora ISO 8601 em que o push expira; nulo se expirado
expires_in	number	86400	Segundos até a expiração (0 se expirado)
html_url	string	"https://.../p/abc"	URL para abrir o push no navegador
json_url	string	"https://.../p/abc.json"	URL para recuperar o push como JSON
name	string or null	"Database credentials"	Nome opcional para o push
note	string or null	null	Nota particular opcional
notify_emails_to	string or null	null	E-mails para notificar sobre a criação (somente premium)
passphrase	string or null	null	Presente somente se o push tiver uma senha (valor oculto)
retrieval_step	boolean	false	Se é necessária uma etapa extra para recuperar
updated_at	string	"2025-02-17T10:00:00.000Z"	Hora da última atualização da ISO 8601
url_token	string	"fkwjfvhall92"	Identificador secreto exclusivo para o push
views_remaining	integer	5	Visualizações restantes antes da expiração

Exemplo de resposta:

{
  "expire_after_duration": 6,
  "expire_after_views": 5,
  "expired": false,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": true,
  "retrieval_step": false,
  "expired_on": null,
  "passphrase": null,
  "created_at": "2025-02-17T10:00:00.000Z",
  "updated_at": "2025-02-17T10:00:00.000Z",
  "expire_after_days": 1,
  "views_remaining": 5,
  "deleted": false,
  "days_remaining": 1,
  "expires_at": "2025-02-18T10:00:00.000Z",
  "expires_in": 86400,
  "json_url": "https://example.com/p/fkwjfvhall92.json",
  "html_url": "https://example.com/p/fkwjfvhall92",
  "account_id": 1,
  "note": null,
  "name": "Database Credentials"
}

Exemplo de solicitação

curl -X POST https://eu.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "MySecretPassword123",
      "expire_after_duration": 6,
      "expire_after_views": 3
    }
  }'

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://eu.pwpush.com/api/v2/pushes')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['Content-Type'] = 'application/json'
request.body = {
  push: {
    payload: 'MySecretPassword123',
    expire_after_duration: 6,
    expire_after_views: 3
  }
}.to_json

response = http.request(request)
puts response.body

import requests
import json

url = 'https://eu.pwpush.com/api/v2/pushes'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}
data = {
    'push': {
        'payload': 'MySecretPassword123',
        'expire_after_duration': 6,
        'expire_after_views': 3
    }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
    'Content-Type' = 'application/json'
}

$body = @{
    push = @{
        payload = 'MySecretPassword123'
        expire_after_duration = 6
        expire_after_views = 3
    }
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri 'https://eu.pwpush.com/api/v2/pushes' `
    -Method Post `
    -Headers $headers `
    -Body $body

$response | ConvertTo-Json

GET /api/v2/pushes/:url_token

Recupera a carga útil secreta de um envio. Isso aumenta a contagem de visualizações e pode expirar o envio.

Campos de resposta

Os campos a seguir são retornados quando se recupera um push. Esse ponto de extremidade retorna a carga útil e os arquivos que não estão disponíveis em outros pontos de extremidade.

Campo	Tipo	Exemplo	Descrição
created_at	string	"2025-02-17T10:00:00.000Z"	Tempo de criação da ISO 8601
days_remaining	integer	1	Descontinuada Dias inteiros restantes (0 quando < 1 dia); preferir expires_at / expires_in
deletable_by_viewer	boolean	true	Se o destinatário pode excluir o envio
deleted	boolean	false	Se o push foi explicitamente excluído
expire_after_days	integer	1	Descontinuada Dias aproximados (derivados da duração)
expire_after_duration	integer	6	Duration enum (0-17)
expire_after_views	integer	5	Máximo de visualizações antes da expiração
expired	boolean	false	Se o push expirou
expired_on	string or null	null	ISO 8601 quando o push expirou; nulo se não tiver expirado
expires_at	string or null	"2025-02-18T10:00:00.000Z"	Hora ISO 8601 em que o push expira; nulo se expirado
expires_in	number	86400	Segundos até a expiração (0 se expirado)
files	array	[{ filename, content_type, url }]	Metadados de arquivos anexados com URLs de download
html_url	string	"https://.../p/abc"	URL para abrir o push no navegador
json_url	string	"https://.../p/abc.json"	URL para recuperar o push como JSON
passphrase	string or null	null	Presente somente se o push tiver uma senha (valor oculto)
payload	string or null	"secret123"	O conteúdo secreto; nulo quando expirado
retrieval_step	boolean	false	Se é necessária uma etapa extra para recuperar
updated_at	string	"2025-02-17T10:00:00.000Z"	Hora da última atualização da ISO 8601
url_token	string	"fkwjfvhall92"	Identificador secreto exclusivo para o push
views_remaining	integer	2	Visualizações restantes antes da expiração

Exemplo de solicitação

curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92

Exemplo de solicitação com senha

curl -X GET "https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"

Exemplo de resposta

{
  "expire_after_duration": 6,
  "expire_after_views": 3,
  "expired": false,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": false,
  "retrieval_step": false,
  "expired_on": null,
  "passphrase": null,
  "created_at": "2025-02-17T10:00:00.000Z",
  "updated_at": "2025-02-17T10:00:00.000Z",
  "expire_after_days": 1,
  "views_remaining": 2,
  "deleted": false,
  "days_remaining": 1,
  "expires_at": "2025-02-18T10:00:00.000Z",
  "expires_in": 86400,
  "json_url": "https://eu.pwpush.com/p/fkwjfvhall92.json",
  "html_url": "https://eu.pwpush.com/p/fkwjfvhall92",
  "payload": "MySecretPassword123",
  "files": []
}

Observação: Se o push tiver uma frase secreta, inclua-a como um parâmetro de consulta: ?passphrase=your_passphrase. A recuperação de um push conta como uma visualização e pode expirar o push se ele atingir o limite de visualizações.

GET /api/v2/pushes/:url_token/preview

Retorna o URL secreto totalmente qualificado de um push sem recuperar a carga útil.

Exemplo de solicitação

curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/preview

Exemplo de resposta

{
  "url": "https://eu.pwpush.com/p/fkwjfvhall92"
}

GET /api/v2/pushes/:url_token/audit

Retorna o registro de auditoria de um push. Requer autenticação e propriedade.

Parâmetros de consulta:

page (opcional): Número da página para paginação.

Padrão: 1 (primeira página)
Alcance: 1 para 200
Retorna até 50 entradas de registro de auditoria por página
Exemplo: ?page=2 para recuperar a segunda página

Exemplo de solicitação

curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Exemplo de resposta

{
  "logs": [
    {
      "ip": "192.168.1.100",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "referrer": null,
      "kind": "creation",
      "created_at": "2023-10-27T10:00:00.000Z",
      "updated_at": "2023-10-27T10:00:00.000Z"
    },
    {
      "ip": "192.168.1.101",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "referrer": "https://example.com",
      "kind": "view",
      "created_at": "2023-10-27T10:05:00.000Z",
      "updated_at": "2023-10-27T10:05:00.000Z"
    }
  ]
}

Observação: O kind indica o tipo de ação registrada. Os valores comuns incluem: creation, view, expire, failed_passphrase, e failed_view.

DELETE /api/v2/pushes/:url_token

Expira imediatamente um push e exclui permanentemente todos os dados confidenciais, inclusive a carga útil e todos os arquivos anexados. Essa ação é irreversível e não pode ser desfeita. Requer autenticação e propriedade, ou o push deve ter sido criado com deletable_by_viewer: true.

Exemplo de solicitação

curl -X DELETE https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Exemplo de resposta

{
  "expire_after_duration": 7,
  "expire_after_views": 5,
  "expired": true,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": false,
  "retrieval_step": false,
  "expired_on": "2023-10-27T10:15:00.000Z",
  "passphrase": null,
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:15:00.000Z",
  "expire_after_days": 7,
  "days_remaining": 0,
  "expires_at": null,
  "expires_in": 0,
  "views_remaining": 0,
  "deleted": true,
  "json_url": "https://eu.pwpush.com/p/fkwjfvhall92.json",
  "html_url": "https://eu.pwpush.com/p/fkwjfvhall92",
  "account_id": 1,
  "note": null,
  "name": null
}

GET /api/v2/pushes/active

Retorna uma lista paginada de seus pushes ativos (não expirados). Requer autenticação.

GET /api/v2/pushes/expired

Retorna uma lista paginada de seus pushes expirados. Requer autenticação.

Parâmetros de consulta:

page (opcional): Número da página para paginação.

Padrão: 1 (primeira página)
Alcance: 1 para 200
Retorna até 50 pressionamentos por página
Exemplo: ?page=2 para recuperar a segunda página

Exemplo de solicitação (ativa)

curl -X GET https://eu.pwpush.com/api/v2/pushes/active \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Exemplo de solicitação (expirado)

curl -X GET https://eu.pwpush.com/api/v2/pushes/expired \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Exemplo de resposta

[
  {
    "expire_after_duration": 7,
    "expire_after_views": 5,
    "expired": false,
    "url_token": "abc123xyz789",
    "deletable_by_viewer": false,
    "retrieval_step": false,
    "expired_on": null,
    "passphrase": null,
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z",
    "expire_after_days": 7,
    "days_remaining": 7,
    "expires_at": "2023-10-29T10:00:00.000Z",
    "expires_in": 172800,
    "views_remaining": 5,
    "deleted": false,
    "json_url": "https://eu.pwpush.com/p/abc123xyz789.json",
    "html_url": "https://eu.pwpush.com/p/abc123xyz789",
    "account_id": 1,
    "note": null,
    "name": null
  },
  {
    "expire_after_duration": 1,
    "expire_after_views": 3,
    "expired": false,
    "url_token": "def456uvw012",
    "deletable_by_viewer": true,
    "retrieval_step": false,
    "expired_on": null,
    "passphrase": null,
    "created_at": "2023-10-26T15:30:00.000Z",
    "updated_at": "2023-10-26T15:30:00.000Z",
    "expire_after_days": 1,
    "days_remaining": 0,
    "expires_at": "2023-10-26T16:00:00.000Z",
    "expires_in": 1200,
    "views_remaining": 2,
    "deleted": false,
    "json_url": "https://eu.pwpush.com/p/def456uvw012.json",
    "html_url": "https://eu.pwpush.com/p/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Última atualização: July 12, 2026

Password Pusher API v2

Empurra

Criar um Push

Corpo da solicitação (JSON)

Corpo da solicitação com arquivos (multipart/form-data)

Parâmetros

Valores de duração para `expire_after_duration`

Campos de resposta

Exemplo de solicitação

Recuperar um Push

Campos de resposta

Exemplo de solicitação

Exemplo de solicitação com senha

Exemplo de resposta

Visualizar um push

Exemplo de solicitação

Exemplo de resposta

Obter registro de auditoria push

Exemplo de solicitação

Exemplo de resposta

Expirar um push

Exemplo de solicitação

Exemplo de resposta

Coleções Push

Exemplo de solicitação (ativa)

Exemplo de solicitação (expirado)

Exemplo de resposta

Password Pusher API v2

Empurra

Criar um Push

Corpo da solicitação (JSON)

Corpo da solicitação com arquivos (multipart/form-data)

Parâmetros

Valores de duração para expire_after_duration

Campos de resposta

Exemplo de solicitação

Recuperar um Push

Campos de resposta

Exemplo de solicitação

Exemplo de solicitação com senha

Exemplo de resposta

Visualizar um push

Exemplo de solicitação

Exemplo de resposta

Obter registro de auditoria push

Exemplo de solicitação

Exemplo de resposta

Expirar um push

Exemplo de solicitação

Exemplo de resposta

Coleções Push

Exemplo de solicitação (ativa)

Exemplo de solicitação (expirado)

Exemplo de resposta

Valores de duração para `expire_after_duration`