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!

Kérések

A kérések biztonságos, kétirányú kommunikációt tesznek lehetővé az érzékeny információk gyűjtéséhez. Létrehozhat egy kérést egy titkos URL-címmel, megoszthatja azt bárkivel, és biztonságos, szöveget vagy fájlokat tartalmazó válaszokat kaphat - mindezt anélkül, hogy az érzékeny adatokat e-mailben, csevegésben vagy naplókban felfedné.

Tökéletes a hitelesítő adatok, API-kulcsok, bizalmas dokumentumok vagy bármilyen érzékeny információ gyűjtésére kollégáktól, ügyfelektől vagy vásárlóktól. A válaszok automatikusan titkosítva vannak, és egy meghatározott időtartam után automatikusan törlődnek, hogy minimalizálják az adatok kitettségét. Az egyes kérések ellenőrzési naplóiban teljes életciklus-követés érhető el.

A kéréseknek három állapota van:

open A kérés elkészült, és válaszra vár. Ossza meg a kérés URL-címét a fogadóval.

ready A válasz megküldésre került és elérhető. Az eredeti kérvényező most már hozzáférhet a válaszhoz.

closed A kérelem lejárt vagy manuálisan lezárásra került. Minden érzékeny adat véglegesen törlésre került.

POST /api/v2/requests

Új kérést hoz létre. Hitelesítést igényel.

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` kötelező	string	A megosztandó kérés szövege/üzenete
`close_after_duration` választható	integer (0-17)	Duration enum - a kérelem lezárásának időpontja
`passphrase` választható	string	A címzetteknek meg kell adniuk ezt a jelszót a megtekintéshez
`name` választható	string	A műszerfalon, értesítésekben és e-mailekben megjelenő név
`note` választható	string	Belső megjegyzés (csak a készítő számára látható)
`retrieval_step` választható	boolean	Segít elkerülni, hogy a chat-rendszerek és az URL-olvasók felfalják a nézeteket
`include_requestor` választható	boolean	A kérvényben a kérvényező adatait is fel kell tüntetni
`response_file_attachments` választható	boolean	Fájlok csatolásának engedélyezése a válaszokban
`files` választható	array	A kérelemhez feltölteni és csatolni kívánt fájl(ok)
`notify_emails_to` választható	string	E-mail címek, amelyekről értesítést kapnak, ha egy kérvényt létrehoznak (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
`authenticated_recipients` választható	boolean	A hozzáférés előtt e-mailes OTP-hitelesítést igényel. A „notify_emails_to” beállítás megadása szükséges. Engedélyezés esetén kizárólag böngészőn keresztül érhető el (az API lekérdezés/válasz 403-as hibakódot ad vissza).
`account_id` választható	integer	A számlaazonosító, amelyhez a kérelmet társítani kell

Időtartam Értékek `close_after_duration`

0: 15 perc

1: 30 perc

2: 45 perc

3: 1 óra

4: 6 óra

5: 12 óra

6: 1 nap

7: 2 nap

8: 3 nap

9: 4 nap

10: 5 nap

11: 6 nap

12: 1 hét

13: 2 hét

14: 3 hét

15: 1 hónapja

16: 2 hónap

17: 3 hónap

Példa kérés

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

Egy nyitott vagy kész kérés tartalmának lekérdezése. Ez lezárhatja a kérést, ha úgy van beállítva, hogy bizonyos számú megtekintés után lezárja azt.

Példa kérés

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

Példa kérés jelszóval

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

Példa válasz (nyitott kérés)

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

Példa válasz (Kész kérés)

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

Megjegyzés: Ha a kérés tartalmaz egy jelszót, adja meg azt lekérdezési paraméterként: ?passphrase=your_passphrase. Egy kérés lekérdezése nézetnek számít, és a kérést lezárhatja, ha eléri a nézeti korlátot.

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

Válaszol egy nyitott kérésre, és állapotát "készenlétre" változtatja.

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][].

Paraméterek

Paraméter	Típus	Leírás
`response` kötelező	string	A kérelemre adott válasz szövege/üzenete
`files` választható	array	A válaszhoz csatolandó fájl(ok) (megköveteli a `response_file_attachments: true` a kérésen)

Megjegyzés: Csak a "nyitott" állapotban lévő kérések kaphatnak választ. Amint egy válasz elküldésre került, a kérelem a "kész" állapotba kerül, és nem fogadhat további válaszokat.

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

Visszaadja a kérelem teljes körűen minősített titkos URL-címét a tartalom lekérdezése nélkül.

Példa kérés

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

Példa Válasz

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

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

Visszaadja a kérelem 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: 1 a címre 200
Oldalanként legfeljebb 50 ellenőrzési naplóbejegyzést ad vissza
Példa: ?page=2 a második oldal lekérdezéséhez

Példa kérés

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/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"
    },
    {
      "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"
    }
  ]
}

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, response, close, failed_passphrase, és failed_view.

DELETE /api/v2/requests/:url_token

Azonnal lezárja a kérelmet, és véglegesen törli a hozzá tartozó összes érzékeny adatot. Ez a művelet visszafordíthatatlan, és nem vonható vissza. Hitelesítést és tulajdonjogot igényel.

Példa kérés

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

Példa Válasz

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

Az aktív (nyitott vagy kész) kérések oldalankénti listáját adja vissza. Hitelesítést igényel.

GET /api/v2/requests/open

Visszaadja a nyitott kérések oldalankénti listáját. Hitelesítést igényel.

GET /api/v2/requests/ready

Visszaadja a kész kérések oldalankénti listáját. Hitelesítést igényel.

GET /api/v2/requests/closed

Visszaadja a lezárt kérések oldalankénti 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: 1 a címre 200
Oldalanként legfeljebb 50 kérés visszaküldése
Példa: ?page=2 a második oldal lekérdezéséhez

Kérés Államok

open

Nyisd ki

A kérés elkészült, és válaszra vár. A kérés szövege látható, de még nem érkezett válasz.

ready

Kész

A kérelemre válaszoltak, és most már tartalmazza a válasz hasznos terhét. A kérés szövege már nem látható, de a válasz lekérhető.

closed

Zárt

A kérést kezelték, és minden érzékeny adat (mind a kérés, mind a válasz) véglegesen törlésre került. Ez az állapot visszafordíthatatlan.

Példa kérés (aktív)

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

Példa kérés (nyitott)

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

Példa kérés (kész)

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

Példa kérés (lezárt)

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

Példa Válasz

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

Megjegyzés: A /active végpont mindkettőben visszaküldi a kéréseket open és ready államok. Használja a címet /open vagy /ready végpontok egy adott állapot szerinti szűréshez.

Utolsó frissítés: July 20, 2026

Password Pusher API v2

Kérések

A kéréseknek három állapota van:

Kérelem létrehozása

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Időtartam Értékek `close_after_duration`

Példa kérés

Kérés lekérdezése

Példa kérés

Példa kérés jelszóval

Példa válasz (nyitott kérés)

Példa válasz (Kész kérés)

Válaszoljon egy kérésre

Request Body (JSON)

Request Body with Files (multipart/form-data)

Paraméterek

Kérés előnézete

Példa kérés

Példa Válasz

Kérés ellenőrzési naplójának lekérdezése

Példa kérés

Példa Válasz

Kérés lezárása

Példa kérés

Példa Válasz

Gyűjtemények kérése

Kérés Államok

Példa kérés (aktív)

Példa kérés (nyitott)

Példa kérés (kész)

Példa kérés (lezárt)

Példa Válasz

Password Pusher API v2

Kérések

A kéréseknek három állapota van:

Kérelem létrehozása

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Időtartam Értékek close_after_duration

Példa kérés

Kérés lekérdezése

Példa kérés

Példa kérés jelszóval

Példa válasz (nyitott kérés)

Példa válasz (Kész kérés)

Válaszoljon egy kérésre

Request Body (JSON)

Request Body with Files (multipart/form-data)

Paraméterek

Kérés előnézete

Példa kérés

Példa Válasz

Kérés ellenőrzési naplójának lekérdezése

Példa kérés

Példa Válasz

Kérés lezárása

Példa kérés

Példa Válasz

Gyűjtemények kérése

Kérés Államok

Példa kérés (aktív)

Példa kérés (nyitott)

Példa kérés (kész)

Példa kérés (lezárt)

Példa Válasz

Időtartam Értékek `close_after_duration`