Password Pusher API v2

BETA

Komplexná 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!

Žiadosti

Žiadosti umožňujú bezpečnú obojsmernú komunikáciu pri zhromažďovaní citlivých informácií. Vytvorte požiadavku s tajnou adresou URL, zdieľajte ju s kýmkoľvek a prijímajte zabezpečené odpovede obsahujúce text alebo súbory - to všetko bez toho, aby ste vystavili citlivé údaje v e-maile, chate alebo protokoloch.

Ideálne na zhromažďovanie poverení, kľúčov API, dôverných dokumentov alebo akýchkoľvek citlivých informácií od kolegov, klientov alebo zákazníkov. Odpovede sa automaticky šifrujú a po uplynutí určeného času sa automaticky vymažú, aby sa minimalizovalo vystavenie údajov. Úplné sledovanie životného cyklu je k dispozícii v záznamoch auditu každej požiadavky.

Žiadosti majú tri stavy:

open Žiadosť bola vytvorená a čaká na odpoveď. Zdieľajte adresu URL žiadosti s príjemcom.

ready Odpoveď bola poskytnutá a je k dispozícii na vyžiadanie. Pôvodný žiadateľ má teraz prístup k odpovedi.

closed Platnosť žiadosti vypršala alebo bola ručne uzavretá. Všetky citlivé údaje boli natrvalo vymazané.

POST /api/v2/requests

Vytvorí novú požiadavku. Vyžaduje overenie.

Request Body (JSON)

{
  "request": {
    "request": "Please provide your hosting information here.",
    "close_after_duration": 8,
    "passphrase": "optional_passphrase",
    "name": "Database Access Request",
    "note": "Internal note",
    "retrieval_step": true,
    "include_requestor": false,
    "response_file_attachments": true
  }
}

Request Body with Files (multipart/form-data)

curl -X POST https://us.pwpush.com/api/v2/requests \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "request[request]=Please provide your hosting information here." \
  -F "request[close_after_duration]=8" \
  -F "request[name]=Database Access Request" \
  -F "request[files][]=@/path/to/document.pdf" \
  -F "request[files][]=@/path/to/spreadsheet.xlsx"

Note: When attaching files, use multipart/form-data format. Multiple files can be attached using request[files][].

Parameters

Parameter	Type	Description
`request` požadované	string	Text žiadosti/správy na zdieľanie
`close_after_duration` voliteľné	integer (0-17)	Enum Duration - kedy sa požiadavka uzavrie
`passphrase` voliteľné	string	Vyžadovať od príjemcov zadanie tejto prístupovej frázy na zobrazenie
`name` voliteľné	string	Meno zobrazené na prístrojovej doske, v oznámeniach a e-mailoch
`note` voliteľné	string	Interná poznámka (viditeľná len pre tvorcu)
`retrieval_step` voliteľné	boolean	Pomáha predchádzať tomu, aby chatovacie systémy a skenery URL spotrebovali zobrazenia
`include_requestor` voliteľné	boolean	Zahrnúť informácie o žiadateľovi do žiadosti
`response_file_attachments` voliteľné	boolean	Povolenie súborov v odpovediach
`files` voliteľné	array	Súbor(-y), ktoré sa majú nahrať a pripojiť k žiadosti
`notify_emails_to` voliteľné	string	E-mailové adresy, ktoré majú byť informované o vytvorení požiadavky (oddelené čiarkami)
`notify_emails_to_locale` voliteľné	string	Lokál (jazyk), v ktorom sa majú odosielať e-mailové oznámenia
`authenticated_recipients` voliteľné	boolean	Pred prístupom je potrebné overenie prostredníctvom jednorazového hesla (OTP) zaslaného e-mailom. Vyžaduje sa nastavenie „notify_emails_to“. Ak je táto funkcia povolená, je dostupná iba v prehliadači (vyvolanie/odpoveď API vráti stav 403).
`account_id` voliteľné	integer	ID účtu, ku ktorému sa má priradiť žiadosť

Hodnoty trvania pre `close_after_duration`

0: 15 minút

1: 30 minút

2: 45 minút

3: 1 hodina

4: 6 hodín

5: 12 hodín

6: 1 deň

7: 2 dni

8: 3 dni

9: 4 dni

10: 5 dní

11: 6 dní

12: 1 týždeň

13: 2 týždne

14: 3 týždne

15: mesiacom

16: 2 mesiace

17: 3 mesiace

Príklad žiadosti

curl -X POST https://us.pwpush.com/api/v2/requests \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request": {
      "request": "Please provide your hosting information here.",
      "close_after_duration": 8,
      "passphrase": "optional_passphrase",
      "name": "Database Access Request"
    }
  }'

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://us.pwpush.com/api/v2/requests')
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 = {
  request: {
    request: 'Please provide your hosting information here.',
    close_after_duration: 8,
    passphrase: 'optional_passphrase',
    name: 'Database Access Request'
  }
}.to_json

response = http.request(request)
puts response.body

import requests
import json

url = 'https://us.pwpush.com/api/v2/requests'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}
data = {
    'request': {
        'request': 'Please provide your hosting information here.',
        'close_after_duration': 8,
        'passphrase': 'optional_passphrase',
        'name': 'Database Access Request'
    }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
    'Content-Type' = 'application/json'
}

$body = @{
    request = @{
        request = 'Please provide your hosting information here.'
        close_after_duration = 8
        passphrase = 'optional_passphrase'
        name = 'Database Access Request'
    }
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri 'https://us.pwpush.com/api/v2/requests' `
    -Method Post `
    -Headers $headers `
    -Body $body

$response | ConvertTo-Json

GET /api/v2/requests/:url_token

Získava obsah otvorenej alebo pripravenej požiadavky. Tým sa môže požiadavka uzavrieť, ak je nakonfigurovaná tak, aby sa uzavrela po určitom počte zobrazení.

Príklad žiadosti

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a

Príklad žiadosti s prístupovou frázou

curl -X GET "https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"

Príklad odpovede (otvorená žiadosť)

{
  "close_after_duration": 8,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": true,
  "passphrase": "optional_passphrase",
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:00:00.000Z",
  "state": "open",
  "include_requestor": false,
  "response_file_attachments": true,
  "close_after_at": "2023-11-04T10:00:00.000Z",
  "days_remaining": 8,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "request": "Please provide your hosting information here.",
  "response": null,
  "files": []
}

Príklad odpovede (požiadavka Ready)

{
  "close_after_duration": 8,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": true,
  "passphrase": "optional_passphrase",
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:00:00.000Z",
  "state": "ready",
  "include_requestor": false,
  "response_file_attachments": true,
  "close_after_at": "2023-11-04T10:00:00.000Z",
  "days_remaining": 8,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "request": null,
  "response": "The API key is: sk_live_1234567890",
  "files": []
}

Poznámka: Ak požiadavka obsahuje prístupovú frázu, uveďte ju ako parameter dotazu: ?passphrase=your_passphrase. Získanie požiadavky sa počíta ako zobrazenie a môže ukončiť požiadavku, ak dosiahne limit zobrazenia.

PATCH /api/v2/requests/:url_token/respond

Reaguje na otvorenú požiadavku a zmení svoj stav na "ready".

Request Body (JSON)

{
  "request": {
    "response": "The API key is: sk_live_1234567890"
  }
}

Request Body with Files (multipart/form-data)

curl -X PATCH https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "request[response]=The API key is: sk_live_1234567890" \
  -F "request[files][]=@/path/to/response_doc.pdf"

Note: When attaching files, use multipart/form-data format. Multiple files can be attached using request[files][].

Parametre

Parameter	Typ	Popis
`response` požadované	string	Text/správu odpovede na žiadosť
`files` voliteľné	array	Súbor(-y), ktorý(-é) sa má(-ú) pripojiť k odpovedi (vyžaduje sa `response_file_attachments: true` na žiadosť)

Poznámka: Odpovede môžu prijímať len požiadavky v stave "otvorené". Po odoslaní odpovede sa žiadosť presunie do stavu "pripravená" a nemôže prijímať ďalšie odpovede.

GET /api/v2/requests/:url_token/preview

Vráti plne kvalifikovanú tajnú adresu URL požiadavky bez načítania obsahu.

Príklad žiadosti

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview

Príklad reakcie

{
  "url": "https://us.pwpush.com/r/orpw2wkg00vpn0a"
}

GET /api/v2/requests/:url_token/audit

Vráti protokol auditu pre požiadavku. Vyžaduje overenie a vlastníctvo.

Parametre dotazu:

page (voliteľné): Číslo strany pre stránkovanie.

Predvolené nastavenie: 1 (prvá strana)
Rozsah: 1 na 200
Vráti až 50 záznamov v denníku auditu na stránku
Príklad: ?page=2 na načítanie druhej stránky

Príklad žiadosti

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/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"
    },
    {
      "ip": "192.168.1.102",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15",
      "referrer": null,
      "kind": "response",
      "created_at": "2023-10-27T10:10:00.000Z",
      "updated_at": "2023-10-27T10:10:00.000Z"
    }
  ]
}

Poznámka: Stránka kind pole označuje typ zaznamenanej akcie. Medzi bežné hodnoty patria: creation, view, response, close, failed_passphrase, a failed_view.

DELETE /api/v2/requests/:url_token

Okamžite uzavrie požiadavku a natrvalo odstráni všetky citlivé údaje, ktoré sú s ňou spojené. Táto akcia je nezvratná a nemožno ju vrátiť späť. Vyžaduje overenie a vlastníctvo.

Príklad žiadosti

curl -X DELETE https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Príklad reakcie

{
  "close_after_duration": null,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": false,
  "passphrase": null,
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:15:00.000Z",
  "state": "closed",
  "include_requestor": false,
  "response_file_attachments": false,
  "close_after_at": null,
  "days_remaining": null,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "account_id": 1,
  "note": null,
  "name": null,
  "request": null,
  "response": null,
  "files": []
}

GET /api/v2/requests/active

Vráti stránkovaný zoznam aktívnych (otvorených alebo pripravených) požiadaviek. Vyžaduje overenie.

GET /api/v2/requests/open

Vráti stránkovaný zoznam otvorených požiadaviek. Vyžaduje overenie.

GET /api/v2/requests/ready

Vráti stránkovaný zoznam pripravených požiadaviek. Vyžaduje overenie.

GET /api/v2/requests/closed

Vráti stránkovaný zoznam uzavretých požiadaviek. Vyžaduje overenie.

Parametre dotazu:

page (voliteľné): Číslo strany pre stránkovanie.

Predvolené nastavenie: 1 (prvá strana)
Rozsah: 1 na 200
Vráti až 50 požiadaviek na stránku
Príklad: ?page=2 na načítanie druhej stránky

Žiadosť štátov

open

Otvorte stránku

Žiadosť bola vytvorená a čaká na odpoveď. Text žiadosti je viditeľný, ale zatiaľ nebola poskytnutá žiadna odpoveď.

ready

Pripravené

Na žiadosť bolo odpovedané a teraz obsahuje užitočné zaťaženie odpovede. Text požiadavky už nie je viditeľný, ale odpoveď je k dispozícii na načítanie.

closed

Uzavreté

Žiadosť bola spracovaná a všetky citlivé údaje (žiadosť aj odpoveď) boli natrvalo vymazané. Tento stav je nezvratný.

Príklad žiadosti (aktívna)

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

Príklad žiadosti (otvorená)

curl -X GET https://us.pwpush.com/api/v2/requests/open \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Príklad žiadosti (pripravené)

curl -X GET https://us.pwpush.com/api/v2/requests/ready \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Príklad žiadosti (uzavretá)

curl -X GET https://us.pwpush.com/api/v2/requests/closed \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Príklad reakcie

[
  {
    "close_after_duration": 7,
    "url_token": "abc123xyz789",
    "retrieval_step": false,
    "passphrase": null,
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z",
    "state": "open",
    "include_requestor": false,
    "response_file_attachments": false,
    "close_after_at": "2023-11-03T10:00:00.000Z",
    "days_remaining": 7,
    "json_url": "https://us.pwpush.com/r/abc123xyz789.json",
    "html_url": "https://us.pwpush.com/r/abc123xyz789",
    "account_id": 1,
    "note": null,
    "name": null
  },
  {
    "close_after_duration": 7,
    "url_token": "def456uvw012",
    "retrieval_step": false,
    "passphrase": null,
    "created_at": "2023-10-26T15:30:00.000Z",
    "updated_at": "2023-10-27T09:00:00.000Z",
    "state": "ready",
    "include_requestor": false,
    "response_file_attachments": false,
    "close_after_at": "2023-11-02T15:30:00.000Z",
    "days_remaining": 6,
    "json_url": "https://us.pwpush.com/r/def456uvw012.json",
    "html_url": "https://us.pwpush.com/r/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Poznámka: Stránka /active koncový bod vracia požiadavky v oboch open a ready uvádza. Použite /open alebo /ready koncové body na filtrovanie podľa konkrétneho stavu.

Posledná aktualizácia: July 20, 2026

Password Pusher API v2

Žiadosti

Žiadosti majú tri stavy:

Vytvorenie žiadosti

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Hodnoty trvania pre `close_after_duration`

Príklad žiadosti

Získanie žiadosti

Príklad žiadosti

Príklad žiadosti s prístupovou frázou

Príklad odpovede (otvorená žiadosť)

Príklad odpovede (požiadavka Ready)

Reagovať na žiadosť

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametre

Náhľad požiadavky

Príklad žiadosti

Príklad reakcie

Získať protokol auditu požiadaviek

Príklad žiadosti

Príklad reakcie

Zatvoriť žiadosť

Príklad žiadosti

Príklad reakcie

Žiadosť o zbierky

Žiadosť štátov

Príklad žiadosti (aktívna)

Príklad žiadosti (otvorená)

Príklad žiadosti (pripravené)

Príklad žiadosti (uzavretá)

Príklad reakcie

Password Pusher API v2

Žiadosti

Žiadosti majú tri stavy:

Vytvorenie žiadosti

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Hodnoty trvania pre close_after_duration

Príklad žiadosti

Získanie žiadosti

Príklad žiadosti

Príklad žiadosti s prístupovou frázou

Príklad odpovede (otvorená žiadosť)

Príklad odpovede (požiadavka Ready)

Reagovať na žiadosť

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametre

Náhľad požiadavky

Príklad žiadosti

Príklad reakcie

Získať protokol auditu požiadaviek

Príklad žiadosti

Príklad reakcie

Zatvoriť žiadosť

Príklad žiadosti

Príklad reakcie

Žiadosť o zbierky

Žiadosť štátov

Príklad žiadosti (aktívna)

Príklad žiadosti (otvorená)

Príklad žiadosti (pripravené)

Príklad žiadosti (uzavretá)

Príklad reakcie

Hodnoty trvania pre `close_after_duration`