Password Pusher API v2
BEETAKattava REST API -dokumentaatio integrointia varten Password Pusher sovelluksiisi
Beta-ilmoitus: API v2 on tällä hetkellä beta-versiossa. Vaikka olemme pyrkineet kaikin tavoin varmistamaan vakauden, ennen lopullista julkaisua saattaa tulla rikkovia muutoksia. Otamme mielellämme vastaan palautetta!
Työntää
Työnnöt mahdollistavat arkaluonteisten tietojen turvallisen, yksisuuntaisen siirtämisen vastaanottajille. Luo push, jossa on salainen URL-osoite, joka sisältää tekstiä, tiedostoja, QR-koodeja tai URL-osoitteita, ja jaa se sitten kenelle tahansa - kaikki tämä paljastamatta arkaluonteisia tietoja sähköpostissa, chatissa tai lokitiedoissa.
Sopii erinomaisesti työntekijöiden perehdyttämiseen, tilitietojen lähettämiseen, luottamuksellisten asiakirjojen lähettämiseen tai arkaluonteisten tietojen jakamiseen. Työnnöt vanhentuvat automaattisesti tietyn keston tai katselumäärän jälkeen, ja jokaisen työnnön auditointilokeissa on saatavilla täydellinen elinkaaren seuranta.
POST /api/v2/pushes
Luo uuden pushin annetulla hyötykuormalla.
Pyynnön runko (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
}
Pyynnön runko tiedostojen kanssa (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"
Huom: Kun liität tiedostoja, käytä multipart/form-data muoto ja aseta kind: "file". Useita tiedostoja voidaan liittää käyttämällä push[files][].
Parametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
payload
edellytetään
|
string | Jaettava salainen teksti |
expire_after_duration
valinnainen
|
integer (0-17) | Kesto enum (0-17) |
expire_after_views
valinnainen
|
integer (1-100) | Katselujen määrä ennen vanhentumista |
passphrase
valinnainen
|
string | Vaadi salasana nähdäksesi |
name
valinnainen
|
string | Nimi työntöä varten |
note
valinnainen
|
string | Sisäinen huomautus (näkyy vain luojalle) |
deletable_by_viewer
valinnainen
|
boolean | Salli katsojien poistaa push |
retrieval_step
valinnainen
|
boolean | Vaatii ylimääräisen vaiheen hakemiseen |
kind
valinnainen
|
string | Tyyppi: "teksti", "tiedosto", "url" tai "qr" (oletusarvo on "teksti") |
notify_emails_to
valinnainen
|
string | Sähköpostiosoitteet, joille ilmoitetaan, kun push luodaan (pilkulla erotettuna) |
notify_emails_to_locale
valinnainen
|
string | Paikkakunta (kieli), jolla sähköposti-ilmoitus lähetetään |
account_id
valinnainen
|
integer | Tilin tunnus, johon push liitetään (käyttäjille, joilla on useita tilejä) |
Kestoarvot expire_after_duration
Vastauskentät
Seuraavat kentät palautetaan vastauksessa, kun luodaan työntöä. Huomaa: hyötykuormaa ja tiedostoja EI palauteta luotaessa - ne ovat käytettävissä vain, kun työntöä haetaan GET:llä.
| Kenttä | Tyyppi | Esimerkki | Kuvaus |
|---|---|---|---|
| account_id | integer or null | 1 | Omistajan tilin tunnus |
| created_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601:n luomisen aika |
| days_remaining | integer | 1 | Käytöstä poistettu Kokopäiviä jäljellä (0 kun < 1 päivä); mieluummin expires_at / expires_in |
| deletable_by_viewer | boolean | true | Voiko vastaanottaja poistaa työnnön |
| deleted | boolean | false | Poistettiinko työntö nimenomaisesti |
| expire_after_days | integer | 1 | Käytöstä poistettu Arvioidut päivät (keston perusteella) |
| expire_after_duration | integer | 6 | Kesto enum (0-17); katso taulukko edellä |
| expire_after_views | integer | 5 | Enimmäiskatselu ennen vanhentumista |
| expired | boolean | false | Onko työntäminen päättynyt |
| expired_on | string or null | null | ISO 8601, kun työntö on päättynyt; nolla, jos se ei ole päättynyt |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 -aika, jolloin työntö päättyy; nolla, jos päättynyt |
| expires_in | number | 86400 | Sekuntia vanhentumiseen (0, jos vanhentunut) |
| html_url | string | "https://.../p/abc" | URL-osoite pushin avaamiseksi selaimessa |
| json_url | string | "https://.../p/abc.json" | URL-osoite, josta push haetaan JSON-muodossa |
| name | string or null | "Database credentials" | Työnnön valinnainen nimi |
| note | string or null | null | Valinnainen yksityinen huomautus |
| notify_emails_to | string or null | null | Luomisesta ilmoitettavat sähköpostit (vain premium) |
| passphrase | string or null | null | Esitetään vain, jos pushilla on salasana (arvo piilotettu) |
| retrieval_step | boolean | false | Tarvitaanko ylimääräinen vaihe, jotta voidaan hakea |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601:n viimeinen päivitysaika |
| url_token | string | "fkwjfvhall92" | Työnnön yksilöllinen salainen tunniste |
| views_remaining | integer | 5 | Ennen voimassaolon päättymistä jäljellä olevat näkymät |
Esimerkkivastaus:
{
"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"
}
Esimerkkipyyntö
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
Noudattaa pushin salaisen hyötykuorman. Tämä kasvattaa katselukertaa ja saattaa vanhentua.
Vastauskentät
Seuraavat kentät palautetaan, kun haetaan työntöä. Tämä päätepiste palauttaa hyötykuorman ja tiedostot, jotka eivät ole käytettävissä muissa päätepisteissä.
| Kenttä | Tyyppi | Esimerkki | Kuvaus |
|---|---|---|---|
| created_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601:n luomisen aika |
| days_remaining | integer | 1 | Käytöstä poistettu Kokopäiviä jäljellä (0 kun < 1 päivä); mieluummin expires_at / expires_in |
| deletable_by_viewer | boolean | true | Voiko vastaanottaja poistaa työnnön |
| deleted | boolean | false | Poistettiinko työntö nimenomaisesti |
| expire_after_days | integer | 1 | Käytöstä poistettu Arvioidut päivät (keston perusteella) |
| expire_after_duration | integer | 6 | Kesto enum (0-17) |
| expire_after_views | integer | 5 | Enimmäiskatselu ennen vanhentumista |
| expired | boolean | false | Onko työntäminen päättynyt |
| expired_on | string or null | null | ISO 8601, kun työntö on päättynyt; nolla, jos se ei ole päättynyt |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | ISO 8601 -aika, jolloin työntö päättyy; nolla, jos päättynyt |
| expires_in | number | 86400 | Sekuntia vanhentumiseen (0, jos vanhentunut) |
| files | array | [{ filename, content_type, url }] | Liitetyn tiedoston metatiedot ja lataus URL-osoitteet |
| html_url | string | "https://.../p/abc" | URL-osoite pushin avaamiseksi selaimessa |
| json_url | string | "https://.../p/abc.json" | URL-osoite, josta push haetaan JSON-muodossa |
| passphrase | string or null | null | Esitetään vain, jos pushilla on salasana (arvo piilotettu) |
| payload | string or null | "secret123" | Salainen sisältö; nolla, kun se on vanhentunut |
| retrieval_step | boolean | false | Tarvitaanko ylimääräinen vaihe, jotta voidaan hakea |
| updated_at | string | "2025-02-17T10:00:00.000Z" | ISO 8601:n viimeinen päivitysaika |
| url_token | string | "fkwjfvhall92" | Työnnön yksilöllinen salainen tunniste |
| views_remaining | integer | 2 | Ennen voimassaolon päättymistä jäljellä olevat näkymät |
Esimerkkipyyntö
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
Esimerkkipyyntö salasanalla
curl -X GET "https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"
Esimerkkivastaus
{
"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": []
}
Huom: Jos pushilla on salasana, liitä se kyselyparametriksi: ?passphrase=your_passphrase. Työnnön hakeminen lasketaan näkymäksi, ja työntö voi vanhentua, jos se saavuttaa näkymärajan.
GET /api/v2/pushes/:url_token/preview
Palauttaa pushin täydellisen salaisen URL-osoitteen ilman hyötykuorman hakua.
Esimerkkipyyntö
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/preview
Esimerkkivastaus
{
"url": "https://eu.pwpush.com/p/fkwjfvhall92"
}
GET /api/v2/pushes/:url_token/audit
Palauttaa työntämisen tarkastuslokin. Vaatii todennuksen ja omistajuuden.
Kyselyparametrit:
page (valinnainen): Sivunumero sivunumerointia varten.
- Oletusarvo:
1(ensimmäinen sivu) - Kantama:
1osoitteeseen200 - Palauttaa enintään 50 tarkastuslokimerkintää sivua kohti
- Esimerkki:
?page=2toisen sivun hakemiseksi
Esimerkkipyyntö
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
{
"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"
}
]
}
Huom: The kind kentässä ilmoitetaan kirjatun toiminnon tyyppi. Yleisiä arvoja ovat mm: creation, view, expire, failed_passphrase, ja failed_view.
DELETE /api/v2/pushes/:url_token
Työnnön voimassaolo päättyy välittömästi, ja kaikki arkaluonteiset tiedot, mukaan lukien hyötykuorma ja liitetiedostot, poistetaan pysyvästi. Tämä toimenpide on peruuttamaton, eikä sitä voi peruuttaa. Vaatii todennuksen ja omistajuuden, tai työntö on luotu seuraavalla tavalla deletable_by_viewer: true.
Esimerkkipyyntö
curl -X DELETE https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92 \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
{
"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
Palauttaa sivukohtaisen luettelon aktiivisista (voimassa olevista) työntökohteistasi. Vaatii todennuksen.
GET /api/v2/pushes/expired
Palauttaa sivukohtaisen luettelon vanhentuneista työntöistäsi. Vaatii todennuksen.
Kyselyparametrit:
page (valinnainen): Sivunumero sivunumerointia varten.
- Oletusarvo:
1(ensimmäinen sivu) - Kantama:
1osoitteeseen200 - Palauttaa jopa 50 painallusta sivua kohti
- Esimerkki:
?page=2toisen sivun hakemiseksi
Esimerkkipyyntö (aktiivinen)
curl -X GET https://eu.pwpush.com/api/v2/pushes/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkipyyntö (päättynyt)
curl -X GET https://eu.pwpush.com/api/v2/pushes/expired \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
[
{
"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
}
]
Viimeksi päivitetty: July 12, 2026