Password Pusher API v2
BÉTAÁtfogó REST API dokumentáció az integráláshoz Password Pusher az alkalmazásokba
Béta értesítés: Az API v2 jelenleg béta verzióban van. Bár mindent megtettünk a stabilitás biztosítása érdekében, a végleges kiadás előtt még lehetnek törésszerű változások. Szívesen fogadjuk visszajelzéseit!
Tolja
A push-ok lehetővé teszik az érzékeny adatok biztonságos, egyirányú továbbítását a címzettek felé. Hozzon létre egy push-t egy titkos URL-címmel, amely szöveget, fájlokat, QR-kódokat vagy URL-címeket tartalmaz, majd ossza meg azt bárkivel - mindezt anélkül, hogy érzékeny adatokat tárna fel e-mailben, csevegésben vagy naplóban.
Tökéletes az alkalmazottak felvételéhez, a fiókok hitelesítő adatainak elküldéséhez, bizalmas dokumentumok továbbításához vagy bármilyen érzékeny információ megosztásához. A push-ok automatikusan lejárnak a megadott időtartam vagy megtekintések száma után, és a teljes életciklus-követés elérhető az egyes push-ok ellenőrzési naplóiban.
POST /api/v2/pushes
Új push-t hoz létre a megadott hasznos teherrel.
Kérelem teste (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
}
Kérelem teste fájlokkal (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"
Megjegyzés: Fájlok csatolásakor használja a multipart/form-data formátum és beállítás kind: "file". Több fájl csatolható a push[files][].
Paraméterek
| Paraméter | Típus | Leírás |
|---|---|---|
payload
kötelező
|
string | A titkos szöveg, amit meg kell osztani |
expire_after_duration
választható
|
integer (0-17) | Időtartam enum (0-17) |
expire_after_views
választható
|
integer (1-100) | Megtekintések száma a lejárat előtt |
passphrase
választható
|
string | A megtekintéshez jelszó szükséges |
name
választható
|
string | Egy név a lökéshez |
note
választható
|
string | Belső megjegyzés (csak a készítő számára látható) |
deletable_by_viewer
választható
|
boolean | Lehetővé teszi a nézők számára a push törlését |
retrieval_step
választható
|
boolean | A lekérdezéshez további lépésre van szükség |
kind
választható
|
string | Típus: "text", "file", "url", vagy "qr" (alapértelmezett "text") |
notify_emails_to
választható
|
string | E-mail címek, amelyekről értesítést kapnak, ha egy push létrejön (vesszővel elválasztva) |
notify_emails_to_locale
választható
|
string | Helyszín (nyelv), amelyen az e-mail értesítés(eke)t küldeni kívánja |
account_id
választható
|
integer | A fiók azonosítója, amelyhez a push-t társítani kell (több fiókkal rendelkező felhasználók esetében) |
Időtartam Értékek expire_after_duration
Válaszmezők
A következő mezőket kapja vissza a válaszban, amikor létrehoz egy push-t. Megjegyzés: a payload és a fájlok NEM kerülnek vissza a létrehozáskor - ezek csak akkor állnak rendelkezésre, ha a push GET-en keresztül történik a lekérdezés.
| Terep | Típus | Példa | Leírás |
|---|---|---|---|
| account_id | integer or null | 1 | Tulajdonosi számla azonosítója |
| created_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 létrehozásának ideje |
| days_remaining | integer | 1 | Elavult Egész napok maradtak (0, ha < 1 nap); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | A címzett törölheti-e a push-t |
| deleted | boolean | false | Kifejezetten törölték-e a push-t |
| expire_after_days | integer | 1 | Elavult Hozzávetőleges napok (az időtartamból származtatva) |
| expire_after_duration | integer | 6 | Időtartam enum (0-17); lásd a fenti táblázatot |
| expire_after_views | integer | 5 | Maximális megtekintés a lejárat előtt |
| expired | boolean | false | Lejárt-e a push |
| expired_on | string or null | null | ISO 8601, amikor a push lejárt; nulla, ha nem járt le |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 idő, amikor a push lejár; null, ha lejárt |
| expires_in | number | 86400 | Másodpercek a lejáratig (0, ha lejárt) |
| html_url | string | "https://.../p/abc" | URL a push megnyitásához a böngészőben |
| json_url | string | "https://.../p/abc.json" | URL a push JSON-ként való lekérdezéséhez |
| name | string or null | "Database credentials" | A push nem kötelező neve |
| note | string or null | null | Választható magánjellegű megjegyzés |
| notify_emails_to | string or null | null | E-mail értesítések létrehozása esetén (csak prémium) |
| passphrase | string or null | null | Csak akkor jelenik meg, ha a push rendelkezik jelszóval (értéke rejtett) |
| retrieval_step | boolean | false | Szükség van-e további lépésre a következők lekérdezéséhez |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 utolsó frissítés időpontja |
| url_token | string | "fkwjfvhall92" | Egyedi titkos azonosító a toláshoz |
| views_remaining | integer | 5 | A lejárat előtt hátralévő nézetek |
Példa válasz:
{
"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"
}
Példa kérés
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
Egy push titkos hasznos terhelésének lekérdezése. Ez növeli a nézetszámot, és lejárhat a push.
Válaszmezők
A következő mezőket kapja vissza a rendszer, amikor egy push-t lekérdezi. Ez a végpont visszaadja a hasznos terhelést és a fájlokat, amelyek más végpontokon nem állnak rendelkezésre.
| Terep | Típus | Példa | Leírás |
|---|---|---|---|
| created_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 létrehozásának ideje |
| days_remaining | integer | 1 | Elavult Egész napok maradtak (0, ha < 1 nap); prefer expires_at / expires_in |
| deletable_by_viewer | boolean | true | A címzett törölheti-e a push-t |
| deleted | boolean | false | Kifejezetten törölték-e a push-t |
| expire_after_days | integer | 1 | Elavult Hozzávetőleges napok (az időtartamból származtatva) |
| expire_after_duration | integer | 6 | Időtartam enum (0-17) |
| expire_after_views | integer | 5 | Maximális megtekintés a lejárat előtt |
| expired | boolean | false | Lejárt-e a push |
| expired_on | string or null | null | ISO 8601, amikor a push lejárt; nulla, ha nem járt le |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 idő, amikor a push lejár; null, ha lejárt |
| expires_in | number | 86400 | Másodpercek a lejáratig (0, ha lejárt) |
| files | array | [{ filename, content_type, url }] | Csatolt fájl metaadatok letöltési URL-címekkel |
| html_url | string | "https://.../p/abc" | URL a push megnyitásához a böngészőben |
| json_url | string | "https://.../p/abc.json" | URL a push JSON-ként való lekérdezéséhez |
| passphrase | string or null | null | Csak akkor jelenik meg, ha a push rendelkezik jelszóval (értéke rejtett) |
| payload | string or null | "secret123" | A titkos tartalom; lejártakor nulla |
| retrieval_step | boolean | false | Szükség van-e további lépésre a következők lekérdezéséhez |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601 utolsó frissítés időpontja |
| url_token | string | "fkwjfvhall92" | Egyedi titkos azonosító a toláshoz |
| views_remaining | integer | 2 | A lejárat előtt hátralévő nézetek |
Példa kérés
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
Példa kérés jelszóval
curl -X GET "https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"
Példa Válasz
{
"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": []
}
Megjegyzés: Ha a push rendelkezik jelszavával, adja meg azt lekérdezési paraméterként: ?passphrase=your_passphrase. Egy push lekérdezése nézetnek számít, és a push lejárhat, ha eléri a nézeti korlátot.
GET /api/v2/pushes/:url_token/preview
Visszaadja egy push teljes minősítésű titkos URL-címét a hasznos teher lekérdezése nélkül.
Példa kérés
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/preview
Példa Válasz
{
"url": "https://eu.pwpush.com/p/fkwjfvhall92"
}
GET /api/v2/pushes/:url_token/audit
Visszaadja egy push ellenőrzési naplóját. Hitelesítés és tulajdonjog szükséges.
Lekérdezési paraméterek:
page (választható): Oldalszám az oldalszámozáshoz.
- Alapértelmezett:
1(első oldal) - Hatótávolság:
1a címre200 - Oldalanként legfeljebb 50 ellenőrzési naplóbejegyzést ad vissza
- Példa:
?page=2a második oldal lekérdezéséhez
Példa kérés
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Példa Válasz
{
"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"
}
]
}
Megjegyzés: A kind mező a naplózott művelet típusát jelzi. Az általános értékek a következők: creation, view, expire, failed_passphrase, és failed_view.
DELETE /api/v2/pushes/:url_token
Azonnal megszűnik egy push és véglegesen törli az összes érzékeny adatot, beleértve a hasznos terhet és a csatolt fájlokat is. Ez a művelet visszafordíthatatlan és nem vonható vissza. Hitelesítést és tulajdonjogot igényel, vagy a push-t a következővel kell létrehozni deletable_by_viewer: true.
Példa kérés
curl -X DELETE https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92 \
-H "Authorization: Bearer YOUR_API_TOKEN"
Példa Válasz
{
"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
Visszaadja az aktív (nem lejárt) push-ok oldalankénti listáját. Hitelesítést igényel.
GET /api/v2/pushes/expired
Visszaadja a lejárt push-ok oldalszámozott listáját. Hitelesítést igényel.
Lekérdezési paraméterek:
page (választható): Oldalszám az oldalszámozáshoz.
- Alapértelmezett:
1(első oldal) - Hatótávolság:
1a címre200 - Oldalanként legfeljebb 50 nyomást ad vissza
- Példa:
?page=2a második oldal lekérdezéséhez
Példa kérés (aktív)
curl -X GET https://eu.pwpush.com/api/v2/pushes/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Példa kérés (lejárt)
curl -X GET https://eu.pwpush.com/api/v2/pushes/expired \
-H "Authorization: Bearer YOUR_API_TOKEN"
Példa Válasz
[
{
"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
}
]
Utolsó frissítés: July 12, 2026