Password Pusher API v2

BETA versija

Visaptveroša REST API dokumentācija integrēšanai Password Pusher savās lietojumprogrammās

Beta paziņojums: API v2 pašlaik ir beta versijā. Lai gan esam pielikuši visas pūles, lai nodrošinātu stabilitāti, pirms galīgās versijas iznākšanas var notikt izmaiņas. Mēs gaidām jūsu atsauksmes!

Spiež

Sūtījumi nodrošina drošu, vienvirziena sensitīvu datu pārsūtīšanu saņēmējiem. Izveidojiet push ar slepenu URL, kurā ir teksts, faili, QR kodi vai URL, un pēc tam kopīgojiet to ar jebkuru personu - un tas viss notiek, neizpaužot sensitīvus datus e-pastā, tērzēšanā vai žurnālos.

Ideāli piemērots darbinieku uzņemšanai darbā, konta akreditācijas datu nosūtīšanai, konfidenciālu dokumentu pārsūtīšanai vai jebkuras sensitīvas informācijas kopīgošanai. Push automātiski beidzas pēc noteikta ilguma vai skatījumu skaita, un katra push audita žurnālos ir pieejama pilna dzīves cikla izsekošana.

POST /api/v2/pushes

Izveido jaunu push ar norādīto komerckravu.

Pieprasījuma struktūra (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
}

Pieprasījuma ķermenis ar failiem (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"

Piezīme: Pievienojot failus, izmantojiet multipart/form-data formātu un iestatīt kind: "file". Var pievienot vairākus failus, izmantojot push[files][].

Parametri

Parametrs	Tips	Apraksts
`payload` obligāts	string	Slepenais teksts, ar kuru dalīties
`expire_after_duration` neobligāts	integer (0-17)	Ilguma enums (0-17)
`expire_after_views` neobligāts	integer (1-100)	Skatījumu skaits pirms derīguma termiņa beigām
`passphrase` neobligāts	string	Nepieciešama piekļuves frāze, lai skatītu
`name` neobligāts	string	Nosaukums, kas nepieciešams, lai virzītos uz priekšu
`note` neobligāts	string	Iekšēja piezīme (redzama tikai autoram)
`deletable_by_viewer` neobligāts	boolean	Ļaujiet skatītājiem dzēst push
`retrieval_step` neobligāts	boolean	Nepieciešams papildu solis, lai iegūtu
`kind` neobligāts	string	Veids: (noklusējuma iestatījums ir "text", "file", "url" vai "qr" (noklusējuma iestatījums ir "text")
`notify_emails_to` neobligāts	string	E-pasta adreses, kas tiks informētas, kad tiek izveidots push (atdalītas komatā)
`notify_emails_to_locale` neobligāts	string	Vietne (valoda), kurā sūtīt e-pasta paziņojumu(-us)
`account_id` neobligāts	integer	Konta ID, ar kuru saistīt grūdienu (lietotājiem ar vairākiem kontiem)

Ilgums Vērtības `expire_after_duration`

0: 15 minūtes

1: 30 minūtes

2: 45 minūtes

3: 1 stunda

4: 6 stundas

5: 12 stundas

6: diena

7: 2 dienas

8: 3 dienas

9: 4 dienas

10: 5 dienas

11: 6 dienas

12: 1 nedēļa

13: 2 nedēļas

14: 3 nedēļas

15: mēnesis

16: 2 mēneši

17: 3 mēneši

Atbildes lauki

Veidojot push, atbildē tiek atgriezti šādi lauki. Piezīme: radīšanas laikā NEKAŠĒJAS ielādes un faili - tie ir pieejami tikai tad, kad push tiek iegūts, izmantojot GET.

Laukums	Tips	Piemērs	Apraksts
account_id	integer or null	1	Īpašnieka konta ID
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 izveides laiks
days_remaining	integer	1	Novecojis Atlikušo dienu skaits (0, ja < 1 diena); vēlams expires_at / expires_in
deletable_by_viewer	boolean	true	Vai saņēmējs var dzēst push
deleted	boolean	false	Vai grūdiens ir skaidri dzēsts
expire_after_days	integer	1	Novecojis Aptuvenais dienu skaits (aprēķināts pēc ilguma)
expire_after_duration	integer	6	Ilguma enums (0-17); skatīt tabulu iepriekš
expire_after_views	integer	5	Maksimālais skatījumu skaits pirms derīguma termiņa beigām
expired	boolean	false	Vai push ir beidzies
expired_on	string or null	null	ISO 8601, kad push beidzies; null, ja nav beidzies
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 laiks, kad beidzas push; null, ja beidzies
expires_in	number	86400	Sekundes līdz derīguma termiņa beigām (0, ja derīguma termiņš beidzies)
html_url	string	"https://.../p/abc"	URL, lai atvērtu push pārlūkprogrammā
json_url	string	"https://.../p/abc.json"	URL, lai iegūtu push kā JSON
name	string or null	"Database credentials"	Neobligāts push nosaukums
note	string or null	null	Neobligāta privāta piezīme
notify_emails_to	string or null	null	E-pasti, lai paziņotu par izveidošanu (tikai Premium)
passphrase	string or null	null	Uzrādīt tikai tad, ja spiedienam ir piekļuves frāze (vērtība slēpta)
retrieval_step	boolean	false	Vai ir nepieciešams papildu posms, lai iegūtu
updated_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 pēdējās atjaunināšanas laiks
url_token	string	"fkwjfvhall92"	Vienreizējs slepenais identifikators
views_remaining	integer	5	Skatījumi, kas palikuši pirms derīguma termiņa beigām

Atbildes piemērs:

{
  "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"
}

Pieprasījuma piemērs

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

Atgūst push slepeno ielādi. Tādējādi tiek palielināts skatījumu skaits un var beigties push derīguma termiņš.

Atbildes lauki

Atgūstot push, tiek atgriezti šādi lauki. Šis galapunkts atgriež komerckravu un failus, kas nav pieejami citos galapunktos.

Laukums	Tips	Piemērs	Apraksts
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 izveides laiks
days_remaining	integer	1	Novecojis Atlikušo dienu skaits (0, ja < 1 diena); vēlams expires_at / expires_in
deletable_by_viewer	boolean	true	Vai saņēmējs var dzēst push
deleted	boolean	false	Vai grūdiens ir skaidri dzēsts
expire_after_days	integer	1	Novecojis Aptuvenais dienu skaits (aprēķināts pēc ilguma)
expire_after_duration	integer	6	Ilguma enums (0-17)
expire_after_views	integer	5	Maksimālais skatījumu skaits pirms derīguma termiņa beigām
expired	boolean	false	Vai push ir beidzies
expired_on	string or null	null	ISO 8601, kad push beidzies; null, ja nav beidzies
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 laiks, kad beidzas push; null, ja beidzies
expires_in	number	86400	Sekundes līdz derīguma termiņa beigām (0, ja derīguma termiņš beidzies)
files	array	[{ filename, content_type, url }]	Pievienotie failu metadati ar lejupielādes URL adresēm
html_url	string	"https://.../p/abc"	URL, lai atvērtu push pārlūkprogrammā
json_url	string	"https://.../p/abc.json"	URL, lai iegūtu push kā JSON
passphrase	string or null	null	Uzrādīt tikai tad, ja spiedienam ir piekļuves frāze (vērtība slēpta)
payload	string or null	"secret123"	Slepenais saturs; nulles vērtība, ja beidzies derīguma termiņš
retrieval_step	boolean	false	Vai ir nepieciešams papildu posms, lai iegūtu
updated_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 pēdējās atjaunināšanas laiks
url_token	string	"fkwjfvhall92"	Vienreizējs slepenais identifikators
views_remaining	integer	2	Skatījumi, kas palikuši pirms derīguma termiņa beigām

Pieprasījuma piemērs

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

Pieprasījuma piemērs ar piekļuves frāzi

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

Atbildes piemērs

{
  "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": []
}

Piezīme: Ja spiedienam ir piekļuves frāze, iekļaujiet to kā vaicājuma parametru: ?passphrase=your_passphrase. Push atgūšana tiek uzskatīta par skatījumu un var beigties, ja tiek sasniegts skatījumu limits.

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

Atgriež pilnībā kvalificētu sūtījuma slepeno URL adresi, neiegūstot lietderīgo slodzi.

Pieprasījuma piemērs

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

Atbildes piemērs

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

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

Atgriež audita žurnālu, kas attiecas uz grūdienu. Nepieciešama autentifikācija un īpašumtiesības.

Vaicājuma parametri:

page (neobligāts): Lapas numurs lappušu numerācijai.

Noklusējuma iestatījumi: 1 (pirmā lapa)
Diapazons: 1 uz 200
Atgriež līdz 50 revīzijas žurnāla ierakstiem vienā lapā
Piemērs: ?page=2 lai iegūtu otro lapu

Pieprasījuma piemērs

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

Atbildes piemērs

{
  "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"
    }
  ]
}

Piezīme: Portāls kind lauks norāda reģistrētās darbības veidu. Biežāk izmantotās vērtības ir šādas: creation, view, expire, failed_passphrase, un failed_view.

DELETE /api/v2/pushes/:url_token

Tūlīt beidzas push un neatgriezeniski tiek dzēsti visi sensitīvie dati, tostarp ielāde un visi pievienotie faili. Šī darbība ir neatgriezeniska, un to nevar atcelt. Nepieciešama autentifikācija un īpašumtiesības, vai arī sūtījums ir izveidots ar deletable_by_viewer: true.

Pieprasījuma piemērs

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

Atbildes piemērs

{
  "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

Atgriež jūsu aktīvo (neizbeigto) spiedienu sarakstu ar lappusēm. Nepieciešama autentifikācija.

GET /api/v2/pushes/expired

Atgriež sarakstu ar lapiņām, kurā ir norādīti pieprasījumi, kuru derīguma termiņš ir beidzies. Nepieciešama autentifikācija.

Vaicājuma parametri:

page (neobligāts): Lapas numurs lappušu numerācijai.

Noklusējuma iestatījumi: 1 (pirmā lapa)
Diapazons: 1 uz 200
Atgriež līdz 50 nospiedumiem vienā lapā
Piemērs: ?page=2 lai iegūtu otro lapu

Pieprasījuma piemērs (aktīvs)

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

Pieprasījuma piemērs (beidzies)

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

Atbildes piemērs

[
  {
    "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
  }
]

Pēdējo reizi atjaunināts: July 12, 2026

Password Pusher API v2

Spiež

Veidot Push

Pieprasījuma struktūra (JSON)

Pieprasījuma ķermenis ar failiem (multipart/form-data)

Parametri

Ilgums Vērtības `expire_after_duration`

Atbildes lauki

Pieprasījuma piemērs

Push atgūšana

Atbildes lauki

Pieprasījuma piemērs

Pieprasījuma piemērs ar piekļuves frāzi

Atbildes piemērs

Priekšskatījums Push

Pieprasījuma piemērs

Atbildes piemērs

Iegūt Push audita žurnālu

Pieprasījuma piemērs

Atbildes piemērs

Push derīguma termiņa beigas

Pieprasījuma piemērs

Atbildes piemērs

Push kolekcijas

Pieprasījuma piemērs (aktīvs)

Pieprasījuma piemērs (beidzies)

Atbildes piemērs

Password Pusher API v2

Spiež

Veidot Push

Pieprasījuma struktūra (JSON)

Pieprasījuma ķermenis ar failiem (multipart/form-data)

Parametri

Ilgums Vērtības expire_after_duration

Atbildes lauki

Pieprasījuma piemērs

Push atgūšana

Atbildes lauki

Pieprasījuma piemērs

Pieprasījuma piemērs ar piekļuves frāzi

Atbildes piemērs

Priekšskatījums Push

Pieprasījuma piemērs

Atbildes piemērs

Iegūt Push audita žurnālu

Pieprasījuma piemērs

Atbildes piemērs

Push derīguma termiņa beigas

Pieprasījuma piemērs

Atbildes piemērs

Push kolekcijas

Pieprasījuma piemērs (aktīvs)

Pieprasījuma piemērs (beidzies)

Atbildes piemērs

Ilgums Vērtības `expire_after_duration`