Password Pusher API v2
BETAKomplexná dokumentácia REST API na integráciu Password Pusher do vašich aplikácií
Oznámenie o beta verzii: Rozhranie API v2 je v súčasnosti vo fáze beta. Hoci sme vynaložili maximálne úsilie na zabezpečenie stability, pred konečným vydaním sa môžu vyskytnúť zmeny. Uvítame vašu spätnú väzbu!
Stlačí
Funkcia Pushes umožňuje bezpečný jednosmerný prenos citlivých údajov príjemcom. Vytvorte push s tajnou adresou URL obsahujúcou text, súbory, kódy QR alebo adresy URL a potom ho zdieľajte s kýmkoľvek - a to všetko bez toho, aby ste odhalili citlivé údaje v e-maile, chate alebo protokoloch.
Ideálne na prijímanie zamestnancov, posielanie poverení k účtu, prenos dôverných dokumentov alebo zdieľanie akýchkoľvek citlivých informácií. Platnosť odoslaní automaticky vyprší po stanovenom trvaní alebo počte zobrazení a v protokoloch auditu každého odoslania je k dispozícii úplné sledovanie životného cyklu.
POST /api/v2/pushes
Vytvorí nový push so zadaným užitočným zaťažením.
Telo požiadavky (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
}
Telo požiadavky so súbormi (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"
Poznámka: Pri pripájaní súborov použite multipart/form-data formát a nastavenie kind: "file". Viacero súborov možno pripojiť pomocou push[files][].
Parametre
| Parameter | Typ | Popis |
|---|---|---|
payload
požadované
|
string | Tajný text na zdieľanie |
expire_after_duration
voliteľné
|
integer (0-17) | Trvanie enum (0-17) |
expire_after_views
voliteľné
|
integer (1-100) | Počet zobrazení pred vypršaním platnosti |
passphrase
voliteľné
|
string | Vyžadovanie prístupovej frázy na zobrazenie |
name
voliteľné
|
string | Názov pre tlač |
note
voliteľné
|
string | Interná poznámka (viditeľná len pre tvorcu) |
deletable_by_viewer
voliteľné
|
boolean | Umožniť divákom odstrániť push |
retrieval_step
voliteľné
|
boolean | Vyžadujú ďalší krok na načítanie |
kind
voliteľné
|
string | Typ: "(predvolené nastavenie je "text") |
notify_emails_to
voliteľné
|
string | E-mailové adresy, ktoré majú byť informované o vytvorení tlačovej správy (oddelené čiarkami) |
notify_emails_to_locale
voliteľné
|
string | Lokál (jazyk), v ktorom sa majú odosielať e-mailové oznámenia |
account_id
voliteľné
|
integer | ID účtu, ku ktorému sa má priradiť push (pre používateľov s viacerými účtami) |
Hodnoty trvania pre expire_after_duration
Polia odpovede
Pri vytváraní tlačidla push sa v odpovedi vrátia nasledujúce polia. Poznámka: užitočné zaťaženie a súbory sa pri vytváraní NEVRAŤAJÚ - sú k dispozícii len pri načítaní tlačovej správy prostredníctvom GET.
| Pole | Typ | Príklad | Popis |
|---|---|---|---|
| account_id | integer or null | 1 | ID účtu vlastníka |
| created_at | string | "2025-02-17T10:00:00.000Z" | Čas vytvorenia ISO 8601 |
| days_remaining | integer | 1 | Vyradené Celé zostávajúce dni (0, keď < 1 deň); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | Či môže príjemca vymazať push |
| deleted | boolean | false | Či bol push výslovne vymazaný |
| expire_after_days | integer | 1 | Vyradené Približný počet dní (odvodený od dĺžky trvania) |
| expire_after_duration | integer | 6 | Trvanie enum (0-17); pozri tabuľku vyššie |
| expire_after_views | integer | 5 | Maximálny počet zobrazení pred vypršaním platnosti |
| expired | boolean | false | Či platnosť tlačidla vypršala |
| expired_on | string or null | null | ISO 8601, keď platnosť tlačidla vypršala; null, ak platnosť nevypršala |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 čas, kedy push vyprší; null, ak vypršal |
| expires_in | number | 86400 | Sekundy do vypršania platnosti (0, ak vypršala) |
| html_url | string | "https://.../p/abc" | URL na otvorenie tlačidla v prehliadači |
| json_url | string | "https://.../p/abc.json" | URL na načítanie push ako JSON |
| name | string or null | "Database credentials" | Voliteľný názov pre push |
| note | string or null | null | Voliteľná súkromná poznámka |
| notify_emails_to | string or null | null | E-maily na upozornenie pri vytvorení (iba prémiové) |
| passphrase | string or null | null | Zobrazí sa len vtedy, ak má push prístupovú frázu (hodnota skrytá) |
| retrieval_step | boolean | false | Či je potrebný ďalší krok na načítanie |
| updated_at | string | "2025-02-17T10:00:00.000Z" | Čas poslednej aktualizácie ISO 8601 |
| url_token | string | "fkwjfvhall92" | Jedinečný tajný identifikátor pre push |
| views_remaining | integer | 5 | Zobrazenia, ktoré zostali pred uplynutím platnosti |
Príklad odpovede:
{
"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"
}
Príklad žiadosti
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
Získava tajné užitočné zaťaženie tlačidla. Tým sa zvýši počet zobrazení a môže sa ukončiť platnosť tlačidla.
Polia odpovede
Pri načítaní tlačidla sa vrátia nasledujúce polia. Tento koncový bod vracia užitočné zaťaženie a súbory, ktoré nie sú dostupné na iných koncových bodoch.
| Pole | Typ | Príklad | Popis |
|---|---|---|---|
| created_at | string | "2025-02-17T10:00:00.000Z" | Čas vytvorenia ISO 8601 |
| days_remaining | integer | 1 | Vyradené Celé zostávajúce dni (0, keď < 1 deň); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | Či môže príjemca vymazať push |
| deleted | boolean | false | Či bol push výslovne vymazaný |
| expire_after_days | integer | 1 | Vyradené Približný počet dní (odvodený od dĺžky trvania) |
| expire_after_duration | integer | 6 | Trvanie enum (0-17) |
| expire_after_views | integer | 5 | Maximálny počet zobrazení pred vypršaním platnosti |
| expired | boolean | false | Či platnosť tlačidla vypršala |
| expired_on | string or null | null | ISO 8601, keď platnosť tlačidla vypršala; null, ak platnosť nevypršala |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 čas, kedy push vyprší; null, ak vypršal |
| expires_in | number | 86400 | Sekundy do vypršania platnosti (0, ak vypršala) |
| files | array | [{ filename, content_type, url }] | Pripojené metadáta súborov s adresami URL na stiahnutie |
| html_url | string | "https://.../p/abc" | URL na otvorenie tlačidla v prehliadači |
| json_url | string | "https://.../p/abc.json" | URL na načítanie push ako JSON |
| passphrase | string or null | null | Zobrazí sa len vtedy, ak má push prístupovú frázu (hodnota skrytá) |
| payload | string or null | "secret123" | Tajný obsah; po uplynutí platnosti je nulový |
| retrieval_step | boolean | false | Či je potrebný ďalší krok na načítanie |
| updated_at | string | "2025-02-17T10:00:00.000Z" | Čas poslednej aktualizácie ISO 8601 |
| url_token | string | "fkwjfvhall92" | Jedinečný tajný identifikátor pre push |
| views_remaining | integer | 2 | Zobrazenia, ktoré zostali pred uplynutím platnosti |
Príklad žiadosti
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
Príklad žiadosti s prístupovou frázou
curl -X GET "https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"
Príklad reakcie
{
"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": []
}
Poznámka: Ak je súčasťou tlačidla push prístupová fráza, uveďte ju ako parameter dotazu: ?passphrase=your_passphrase. Získanie tlačovej správy sa počíta ako zobrazenie a môže vypršať, ak sa dosiahne limit zobrazenia.
GET /api/v2/pushes/:url_token/preview
Vráti plne kvalifikovanú tajnú adresu URL tlačidla bez načítania užitočného zaťaženia.
Príklad žiadosti
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/preview
Príklad reakcie
{
"url": "https://eu.pwpush.com/p/fkwjfvhall92"
}
GET /api/v2/pushes/:url_token/audit
Vráti protokol auditu pre príkaz push. Vyžaduje overenie a vlastníctvo.
Parametre dotazu:
page (voliteľné): Číslo strany pre stránkovanie.
- Predvolené nastavenie:
1(prvá strana) - Rozsah:
1na200 - Vráti až 50 záznamov v denníku auditu na stránku
- Príklad:
?page=2na načítanie druhej stránky
Príklad žiadosti
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Príklad reakcie
{
"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"
}
]
}
Poznámka: Stránka kind pole označuje typ zaznamenanej akcie. Medzi bežné hodnoty patria: creation, view, expire, failed_passphrase, a failed_view.
DELETE /api/v2/pushes/:url_token
Okamžite ukončí platnosť tlačidla a natrvalo odstráni všetky citlivé údaje vrátane užitočného zaťaženia a všetkých pripojených súborov. Táto akcia je nezvratná a nedá sa vrátiť späť. Vyžaduje overenie a vlastníctvo alebo odoslanie musí byť vytvorené pomocou deletable_by_viewer: true.
Príklad žiadosti
curl -X DELETE https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92 \
-H "Authorization: Bearer YOUR_API_TOKEN"
Príklad reakcie
{
"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
Vráti stránkovaný zoznam vašich aktívnych (nevypršaných) tlačení. Vyžaduje overenie.
GET /api/v2/pushes/expired
Vráti stránkovaný zoznam vašich vypršaných tlačení. Vyžaduje overenie.
Parametre dotazu:
page (voliteľné): Číslo strany pre stránkovanie.
- Predvolené nastavenie:
1(prvá strana) - Rozsah:
1na200 - Vráti až 50 tlačí na stránku
- Príklad:
?page=2na načítanie druhej stránky
Príklad žiadosti (aktívna)
curl -X GET https://eu.pwpush.com/api/v2/pushes/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Príklad žiadosti (vypršala platnosť)
curl -X GET https://eu.pwpush.com/api/v2/pushes/expired \
-H "Authorization: Bearer YOUR_API_TOKEN"
Príklad reakcie
[
{
"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
}
]
Posledná aktualizácia: July 12, 2026