Password Pusher API v2

BETA

Komplexní dokumentace rozhraní REST API pro integraci Password Pusher do vašich aplikací

Oznámení o betaverzi: Rozhraní API v2 je v současné době ve fázi beta. Přestože jsme vynaložili veškeré úsilí, abychom zajistili stabilitu, může dojít před vydáním finální verze ke zlomovým změnám. Uvítáme vaši zpětnou vazbu!

Žádosti

Žádosti umožňují bezpečnou obousměrnou komunikaci při shromažďování citlivých informací. Vytvořte požadavek s tajnou adresou URL, sdílejte jej s kýmkoli a přijímejte zabezpečené odpovědi obsahující text nebo soubory - to vše bez vystavení citlivých údajů v e-mailu, chatu nebo protokolech.

Je ideální pro shromažďování pověření, klíčů API, důvěrných dokumentů nebo jakýchkoli citlivých informací od kolegů, klientů nebo zákazníků. Odpovědi jsou automaticky šifrovány a po uplynutí stanovené doby se automaticky odstraní, aby se minimalizovalo odhalení dat. Úplné sledování životního cyklu je k dispozici v protokolech auditu každého požadavku.

Žádosti mají tři stavy:

open Požadavek byl vytvořen a čeká na odpověď. Sdílejte adresu URL požadavku s příjemcem.

ready Odpověď byla poskytnuta a je k dispozici k vyhledání. Původní žadatel má nyní k odpovědi přístup.

closed Platnost žádosti vypršela nebo byla ručně uzavřena. Všechny citlivé údaje byly trvale odstraněny.

POST /api/v2/requests

Vytvoří nový požadavek. Vyžaduje ověření.

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://eu.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 žádosti/zprávy ke sdílení
`close_after_duration` volitelný	integer (0-17)	Výčet Duration - kdy se požadavek uzavře
`passphrase` volitelný	string	Požadovat, aby příjemci zadali tuto přístupovou frázi pro zobrazení
`name` volitelný	string	Jméno zobrazené na panelu, v oznámeních a e-mailech
`note` volitelný	string	Interní poznámka (viditelná pouze pro tvůrce)
`retrieval_step` volitelný	boolean	Pomáhá zabránit tomu, aby systémy chatu a skenery URL spotřebovávaly zobrazení
`include_requestor` volitelný	boolean	Zahrnout do žádosti informace o žadateli
`response_file_attachments` volitelný	boolean	Povolení příloh souborů v odpovědích
`files` volitelný	array	Soubor(y), který(é) nahrajete a přiložíte k žádosti
`notify_emails_to` volitelný	string	E-mailové adresy, které mají být informovány o vytvoření požadavku (oddělené čárkou)
`notify_emails_to_locale` volitelný	string	Místní jazyk, ve kterém chcete odesílat e-mailová oznámení
`account_id` volitelný	integer	ID účtu, ke kterému má být požadavek přiřazen

Hodnoty trvání pro `close_after_duration`

0: 15 minut

1: 30 minut

2: 45 minut

3: 1 hodina

4: 6 hodin

5: 12 hodin

6: jeden den

7: 2 dny

8: 3 dny

9: 4 dny

10: 5 dní

11: 6 dní

12: 1 týden

13: 2 týdny

14: 3 týdny

15: měsíc

16: 2 měsíce

17: 3 měsíce

Příklad požadavku

curl -X POST https://eu.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://eu.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://eu.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://eu.pwpush.com/api/v2/requests' `
    -Method Post `
    -Headers $headers `
    -Body $body

$response | ConvertTo-Json

GET /api/v2/requests/:url_token

Získá obsah otevřeného nebo připraveného požadavku. Může dojít k uzavření požadavku, pokud je nakonfigurován tak, aby se uzavřel po určitém počtu zobrazení.

Příklad požadavku

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

Příklad požadavku s přístupovou frází

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

Příklad odpovědi (otevřený požadavek)

{
  "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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "request": "Please provide your hosting information here.",
  "response": null,
  "files": []
}

Příklad odpovědi (požadavek 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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "request": null,
  "response": "The API key is: sk_live_1234567890",
  "files": []
}

Poznámka: Pokud požadavek obsahuje přístupovou frázi, uveďte ji jako parametr dotazu: ?passphrase=your_passphrase. Získání požadavku se počítá jako zobrazení a může dojít k uzavření požadavku, pokud dosáhne limitu zobrazení.

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

Odpoví na otevřený požadavek a změní jeho 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://eu.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][].

Parametry

Parametr	Typ	Popis
`response` Požadované	string	Text/zpráva odpovědi na požadavek
`files` volitelný	array	Soubor(y), který(é) má(jí) být přiložen(y) k odpovědi (vyžaduje) `response_file_attachments: true` na žádost)

Poznámka: Odpovědi lze přijímat pouze na požadavky ve stavu "otevřeno". Po odeslání odpovědi se požadavek přesune do stavu "připraven" a nemůže přijímat další odpovědi.

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

Vrátí plně kvalifikovanou tajnou adresu URL požadavku bez načtení obsahu.

Příklad požadavku

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

Příklad reakce

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

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

Vrátí protokol auditu pro požadavek. Vyžaduje ověření a vlastnictví.

Parametry dotazu:

page (volitelný): Číslo stránky pro stránkování.

Výchozí nastavení: 1 (první strana)
Rozsah: 1 na 200
Vrátí až 50 záznamů protokolu auditu na stránku
Příklad: ?page=2 pro načtení druhé stránky

Příklad požadavku

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

Příklad reakce

{
  "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: Na stránkách kind pole označuje typ zaznamenané akce. Mezi běžné hodnoty patří: creation, view, response, close, failed_passphrase, a failed_view.

DELETE /api/v2/requests/:url_token

Okamžitě uzavře požadavek a trvale odstraní všechna citlivá data s ním spojená. Tato akce je nevratná a nelze ji vrátit zpět. Vyžaduje ověření a vlastnictví.

Příklad požadavku

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

Příklad reakce

{
  "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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "account_id": 1,
  "note": null,
  "name": null,
  "request": null,
  "response": null,
  "files": []
}

GET /api/v2/requests/active

Vrátí stránkovaný seznam aktivních (otevřených nebo připravených) požadavků. Vyžaduje ověření.

GET /api/v2/requests/open

Vrátí stránkovaný seznam otevřených požadavků. Vyžaduje ověření.

GET /api/v2/requests/ready

Vrátí stránkovaný seznam připravených požadavků. Vyžaduje ověření.

GET /api/v2/requests/closed

Vrátí stránkovaný seznam uzavřených požadavků. Vyžaduje ověření.

Parametry dotazu:

page (volitelný): Číslo stránky pro stránkování.

Výchozí nastavení: 1 (první strana)
Rozsah: 1 na 200
Vrátí až 50 požadavků na stránku
Příklad: ?page=2 pro načtení druhé stránky

Požadavek Státy

open

Otevřená žádost

Požadavek byl vytvořen a čeká na odpověď. Text požadavku je viditelný, ale zatím nebyla poskytnuta žádná odpověď.

ready

Odpověď připravena

Na požadavek bylo odpovězeno a nyní obsahuje užitečné zatížení odpovědi. Text požadavku již není viditelný, ale odpověď je k dispozici pro načtení.

closed

ZAVŘENO

Požadavek byl zpracován a všechna citlivá data (požadavek i odpověď) byla trvale odstraněna. Tento stav je nevratný.

Příklad požadavku (aktivní)

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

Příklad požadavku (otevřený)

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

Příklad požadavku (Připraveno)

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

Příklad požadavku (uzavřený)

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

Příklad reakce

[
  {
    "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://eu.pwpush.com/r/abc123xyz789.json",
    "html_url": "https://eu.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://eu.pwpush.com/r/def456uvw012.json",
    "html_url": "https://eu.pwpush.com/r/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Poznámka: Na stránkách /active koncový bod vrací požadavky v obou open a ready uvádí. Použijte /open nebo /ready koncové body pro filtrování podle konkrétního stavu.

Poslední aktualizace: July 12, 2026

Password Pusher API v2

Žádosti

Žádosti mají tři stavy:

Vytvoření požadavku

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Hodnoty trvání pro `close_after_duration`

Příklad požadavku

Získání požadavku

Příklad požadavku

Příklad požadavku s přístupovou frází

Příklad odpovědi (otevřený požadavek)

Příklad odpovědi (požadavek Ready)

Reagovat na žádost

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametry

Náhled požadavku

Příklad požadavku

Příklad reakce

Získat protokol auditu požadavků

Příklad požadavku

Příklad reakce

Zavřít požadavek

Příklad požadavku

Příklad reakce

Žádost o sbírky

Požadavek Státy

Příklad požadavku (aktivní)

Příklad požadavku (otevřený)

Příklad požadavku (Připraveno)

Příklad požadavku (uzavřený)

Příklad reakce

Password Pusher API v2

Žádosti

Žádosti mají tři stavy:

Vytvoření požadavku

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Hodnoty trvání pro close_after_duration

Příklad požadavku

Získání požadavku

Příklad požadavku

Příklad požadavku s přístupovou frází

Příklad odpovědi (otevřený požadavek)

Příklad odpovědi (požadavek Ready)

Reagovat na žádost

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametry

Náhled požadavku

Příklad požadavku

Příklad reakce

Získat protokol auditu požadavků

Příklad požadavku

Příklad reakce

Zavřít požadavek

Příklad požadavku

Příklad reakce

Žádost o sbírky

Požadavek Státy

Příklad požadavku (aktivní)

Příklad požadavku (otevřený)

Příklad požadavku (Připraveno)

Příklad požadavku (uzavřený)

Příklad reakce

Hodnoty trvání pro `close_after_duration`