Password Pusher API v2
BETAVERSJONOmfattende REST API-dokumentasjon for integrering Password Pusher inn i applikasjonene dine
Beta-varsel: API v2 er for øyeblikket i betaversjon. Vi har gjort vårt ytterste for å sikre stabilitet, men det kan forekomme endringer før den endelige utgivelsen. Vi tar gjerne imot tilbakemeldinger!
Dytter
Push-meldinger muliggjør sikker enveisoverføring av sensitive data til mottakerne. Opprett en push med en hemmelig URL som inneholder tekst, filer, QR-koder eller URL-er, og del den deretter med hvem som helst - uten å eksponere sensitive data i e-post, chat eller logger.
Perfekt for onboarding av ansatte, sending av kontoopplysninger, overføring av konfidensielle dokumenter eller deling av annen sensitiv informasjon. Push-meldinger utløper automatisk etter en spesifisert varighet eller et spesifisert antall visninger, og full livssyklussporing er tilgjengelig i revisjonsloggene for hver push-melding.
POST /api/v2/pushes
Oppretter en ny push med den angitte nyttelasten.
Forespørselstekst (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
}
Forespørselstekst med filer (multipart/form-data)
curl -X POST https://us.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"
Merk: Når du legger ved filer, bruker du multipart/form-data format og sett kind: "file". Flere filer kan legges ved ved hjelp av push[files][].
Params
| Parameter | Type | Beskrivelse |
|---|---|---|
payload
nødvendig
|
string | Den hemmelige teksten å dele |
expire_after_duration
valgfri
|
integer (0-17) | Varighet enum (0-17) |
expire_after_views
valgfri
|
integer (1-100) | Antall visninger før utløp |
passphrase
valgfri
|
string | Krever passordfrase for å vise |
name
valgfri
|
string | Et navn for push |
note
valgfri
|
string | Intern merknad (kun synlig for opphavsmannen) |
deletable_by_viewer
valgfri
|
boolean | Tillat seerne å slette push |
retrieval_step
valgfri
|
boolean | Krever et ekstra trinn for å hente |
kind
valgfri
|
string | Type: "tekst", "fil", "url" eller "qr" (standardinnstilling er "tekst") |
notify_emails_to
valgfri
|
string | E-postadresser som skal varsles når en push opprettes (kommaseparert) |
notify_emails_to_locale
valgfri
|
string | Lokalitet (språk) for å sende e-postvarsling(er) på |
authenticated_recipients
valgfri
|
boolean | Krev bekreftelse via engangskode (OTP) via e-post før visning. Krever «notify_emails_to». Henting er kun mulig via nettleser når funksjonen er aktivert (API-henting returnerer 403). |
account_id
valgfri
|
integer | Konto-ID-en som push-meldingen skal knyttes til (for brukere med flere kontoer) |
Varighet Verdier for expire_after_duration
Svarfelt
Følgende felt returneres i svaret når du oppretter en push. Merk: nyttelast og filer returneres IKKE ved oppretting - de er bare tilgjengelige når du henter en push via GET.
| Felt | Type | Eksempel | Beskrivelse |
|---|---|---|---|
| account_id | integer or null | 1 | Eierens konto-ID |
| created_at | string | "2025-02-17T10:00:00.000Z" | Opprettelsestidspunkt for ISO 8601 |
| days_remaining | integer | 1 | Avviklet Hele dager igjen (0 når < 1 dag); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | Om mottakeren kan slette pushmeldingen |
| deleted | boolean | false | Om push ble eksplisitt slettet |
| expire_after_days | integer | 1 | Avviklet Omtrentlig antall dager (utledet fra varighet) |
| expire_after_duration | integer | 6 | Varighet enum (0-17); se tabellen ovenfor |
| expire_after_views | integer | 5 | Maks antall visninger før utløp |
| expired | boolean | false | Om push-funksjonen har utløpt |
| expired_on | string or null | null | ISO 8601 når push er utløpt; null hvis den ikke er utløpt |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601-tidspunkt for når push utløper; null hvis utløpt |
| expires_in | number | 86400 | Sekunder til utløp (0 hvis utløpt) |
| html_url | string | "https://.../p/abc" | URL for å åpne push i nettleseren |
| json_url | string | "https://.../p/abc.json" | URL for å hente push som JSON |
| name | string or null | "Database credentials" | Valgfritt navn for push |
| note | string or null | null | Valgfritt privat notat |
| notify_emails_to | string or null | null | E-postmeldinger for å varsle ved oppretting (kun premium) |
| passphrase | string or null | null | Kun til stede hvis push har en passordfrase (skjult verdi) |
| retrieval_step | boolean | false | Om det kreves et ekstra trinn for å hente |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 siste oppdateringstidspunkt |
| url_token | string | "fkwjfvhall92" | Unik hemmelig identifikator for push |
| views_remaining | integer | 5 | Visninger igjen før utløp |
Eksempel på svar:
{
"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"
}
Eksempel på forespørsel
curl -X POST https://us.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://us.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://us.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://us.pwpush.com/api/v2/pushes' `
-Method Post `
-Headers $headers `
-Body $body
$response | ConvertTo-Json
GET /api/v2/pushes/:url_token
Henter den hemmelige nyttelasten til en push. Dette øker antall visninger og kan føre til at pushmeldingen utløper.
Svarfelt
Følgende felt returneres når du henter en push. Dette endepunktet returnerer nyttelasten og filer som ikke er tilgjengelige på andre endepunkter.
| Felt | Type | Eksempel | Beskrivelse |
|---|---|---|---|
| created_at | string | "2025-02-17T10:00:00.000Z" | Opprettelsestidspunkt for ISO 8601 |
| days_remaining | integer | 1 | Avviklet Hele dager igjen (0 når < 1 dag); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | Om mottakeren kan slette pushmeldingen |
| deleted | boolean | false | Om push ble eksplisitt slettet |
| expire_after_days | integer | 1 | Avviklet Omtrentlig antall dager (utledet fra varighet) |
| expire_after_duration | integer | 6 | Varighet enum (0-17) |
| expire_after_views | integer | 5 | Maks antall visninger før utløp |
| expired | boolean | false | Om push-funksjonen har utløpt |
| expired_on | string or null | null | ISO 8601 når push er utløpt; null hvis den ikke er utløpt |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601-tidspunkt for når push utløper; null hvis utløpt |
| expires_in | number | 86400 | Sekunder til utløp (0 hvis utløpt) |
| files | array | [{ filename, content_type, url }] | Vedlagt filmetadata med nedlastingsadresser |
| html_url | string | "https://.../p/abc" | URL for å åpne push i nettleseren |
| json_url | string | "https://.../p/abc.json" | URL for å hente push som JSON |
| passphrase | string or null | null | Kun til stede hvis push har en passordfrase (skjult verdi) |
| payload | string or null | "secret123" | Det hemmelige innholdet; null når utløpt |
| retrieval_step | boolean | false | Om det kreves et ekstra trinn for å hente |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 siste oppdateringstidspunkt |
| url_token | string | "fkwjfvhall92" | Unik hemmelig identifikator for push |
| views_remaining | integer | 2 | Visninger igjen før utløp |
Eksempel på forespørsel
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92
Eksempel på forespørsel med passordfrase
curl -X GET "https://us.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"
Eksempel på svar
{
"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://us.pwpush.com/p/fkwjfvhall92.json",
"html_url": "https://us.pwpush.com/p/fkwjfvhall92",
"payload": "MySecretPassword123",
"files": []
}
Merk: Hvis push har en passordfrase, inkluderer du den som en spørringsparameter: ?passphrase=your_passphrase. Å hente en push teller som en visning og kan føre til at pushen utløper hvis den når visningsgrensen.
GET /api/v2/pushes/:url_token/preview
Returnerer den fullt kvalifiserte hemmelige URL-en til en push uten å hente nyttelasten.
Eksempel på forespørsel
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92/preview
Eksempel på svar
{
"url": "https://us.pwpush.com/p/fkwjfvhall92"
}
GET /api/v2/pushes/:url_token/audit
Returnerer revisjonsloggen for en push. Krever autentisering og eierskap.
Parametere for spørring:
page (valgfri): Sidetall for paginering.
- Standard:
1(første side) - Rekkevidde:
1til200 - Returnerer opptil 50 revisjonsloggoppføringer per side
- Eksempel:
?page=2for å hente den andre siden
Eksempel på forespørsel
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på svar
{
"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"
}
]
}
Merk: Den kind feltet angir hvilken type handling som logges. Vanlige verdier inkluderer: creation, view, expire, failed_passphrase, og failed_view.
DELETE /api/v2/pushes/:url_token
Utløper umiddelbart og sletter alle sensitive data permanent, inkludert nyttelasten og eventuelle vedlagte filer. Denne handlingen er irreversibel og kan ikke angres. Krever autentisering og eierskap, eller push må ha blitt opprettet med deletable_by_viewer: true.
Eksempel på forespørsel
curl -X DELETE https://us.pwpush.com/api/v2/pushes/fkwjfvhall92 \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på svar
{
"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://us.pwpush.com/p/fkwjfvhall92.json",
"html_url": "https://us.pwpush.com/p/fkwjfvhall92",
"account_id": 1,
"note": null,
"name": null
}
GET /api/v2/pushes/active
Returnerer en paginert liste over dine aktive (ikke utløpte) pushes. Krever autentisering.
GET /api/v2/pushes/expired
Returnerer en paginert liste over utløpte push-forsendelser. Krever autentisering.
Parametere for spørring:
page (valgfri): Sidetall for paginering.
- Standard:
1(første side) - Rekkevidde:
1til200 - Returnerer opptil 50 trykk per side
- Eksempel:
?page=2for å hente den andre siden
Eksempel på forespørsel (aktiv)
curl -X GET https://us.pwpush.com/api/v2/pushes/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på forespørsel (utløpt)
curl -X GET https://us.pwpush.com/api/v2/pushes/expired \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på svar
[
{
"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://us.pwpush.com/p/abc123xyz789.json",
"html_url": "https://us.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://us.pwpush.com/p/def456uvw012.json",
"html_url": "https://us.pwpush.com/p/def456uvw012",
"account_id": 1,
"note": null,
"name": null
}
]
Sist oppdatert: July 20, 2026