Password Pusher API v2

BETA

Kompleksowa dokumentacja interfejsu API REST do integracji Password Pusher do aplikacji

Powiadomienie o wersji beta: API v2 jest obecnie w wersji beta. Chociaż dołożyliśmy wszelkich starań, aby zapewnić stabilność, przed ostatecznym wydaniem mogą pojawić się przełomowe zmiany. Czekamy na Twoją opinię!

Upraszanie

Żądania umożliwiają bezpieczną, dwukierunkową komunikację w celu gromadzenia poufnych informacji. Utwórz żądanie z tajnym adresem URL, udostępnij je komukolwiek i otrzymuj bezpieczne odpowiedzi zawierające tekst lub pliki - wszystko to bez ujawniania poufnych danych w wiadomościach e-mail, czatach lub dziennikach.

Idealny do zbierania danych uwierzytelniających, kluczy API, poufnych dokumentów lub wszelkich wrażliwych informacji od współpracowników, klientów lub klientów. Odpowiedzi są automatycznie szyfrowane i automatycznie usuwane po określonym czasie, aby zminimalizować narażenie danych. Pełne śledzenie cyklu życia jest dostępne w dziennikach audytu każdego żądania.

Żądania mają trzy stany:

open Żądanie zostało utworzone i oczekuje na odpowiedź. Udostępnij adres URL żądania odbiorcy.

ready Odpowiedź została udzielona i jest dostępna do pobrania. Pierwotny wnioskodawca może teraz uzyskać dostęp do odpowiedzi.

closed Żądanie wygasło lub zostało ręcznie zamknięte. Wszystkie wrażliwe dane zostały trwale usunięte.

POST /api/v2/requests

Tworzy nowe żądanie. Wymaga uwierzytelnienia.

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` wymagany	string	Tekst żądania/wiadomość do udostępnienia
`close_after_duration` opcjonalny	integer (0-17)	Duration enum - kiedy zamknąć żądanie
`passphrase` opcjonalny	string	Wymagaj, aby odbiorcy wprowadzali to hasło w celu wyświetlenia
`name` opcjonalny	string	Nazwa wyświetlana na pulpicie nawigacyjnym, w powiadomieniach i wiadomościach e-mail
`note` opcjonalny	string	Uwaga wewnętrzna (widoczna tylko dla twórcy)
`retrieval_step` opcjonalny	boolean	Pomaga uniknąć pochłaniania widoków przez systemy czatu i skanery adresów URL
`include_requestor` opcjonalny	boolean	Dołączenie do wniosku informacji o wnioskodawcy
`response_file_attachments` opcjonalny	boolean	Zezwalaj na załączanie plików w odpowiedziach
`files` opcjonalny	array	Pliki do przesłania i załączenia do wniosku
`notify_emails_to` opcjonalny	string	Adresy e-mail, które mają być powiadamiane o utworzeniu żądania (rozdzielone przecinkami)
`notify_emails_to_locale` opcjonalny	string	Lokalizacja (język), w której mają być wysyłane powiadomienia e-mail
`authenticated_recipients` opcjonalny	boolean	Wymagaj weryfikacji za pomocą jednorazowego hasła (OTP) wysłanego na adres e-mail przed uzyskaniem dostępu. Wymaga ustawienia parametru `notify_emails_to`. Po włączeniu tej opcji dostępny jest wyłącznie w przeglądarce (wywołania API typu „retrieve” i „respond” zwracają kod błędu 403).
`account_id` opcjonalny	integer	Identyfikator konta, z którym ma zostać skojarzone żądanie

Wartości czasu trwania dla `close_after_duration`

0: 15 minut

1: 30 minut

2: 45 minut

3: 1 godzina

4: 6 godzin

5: 12 godzin

6: 1 dzień

7: 2 dni

8: 3 dni

9: 4 dni

10: 5 dni

11: 6 dni

12: 1 tydzień

13: 2 tygodnie

14: 3 tygodnie

15: 1 miesiąc

16: 2 miesiące

17: 3 miesiące

Przykładowe żądanie

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

Pobiera zawartość otwartego lub gotowego żądania. Może to zamknąć żądanie, jeśli jest skonfigurowane do zamknięcia po określonej liczbie wyświetleń.

Przykładowe żądanie

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

Przykładowe żądanie z hasłem

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

Przykładowa odpowiedź (otwarte żądanie)

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

Przykładowa odpowiedź (żądanie gotowości)

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

Uwaga: Jeśli żądanie zawiera hasło, należy dołączyć je jako parametr zapytania: ?passphrase=your_passphrase. Pobranie żądania liczy się jako widok i może zamknąć żądanie, jeśli osiągnie limit widoku.

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

Odpowiada na otwarte żądanie, zmieniając swój stan na "gotowy".

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

Parametry

Parametr	Typ	Opis
`response` wymagany	string	Tekst/wiadomość odpowiedzi na żądanie
`files` opcjonalny	array	Plik(i) do załączenia do odpowiedzi (wymaga `response_file_attachments: true` na żądanie)

Uwaga: Tylko żądania w stanie "otwarte" mogą otrzymywać odpowiedzi. Po przesłaniu odpowiedzi żądanie przechodzi do stanu "gotowe" i nie może przyjmować dodatkowych odpowiedzi.

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

Zwraca w pełni kwalifikowany tajny adres URL żądania bez pobierania treści.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

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

Zwraca dziennik audytu dla żądania. Wymaga uwierzytelnienia i własności.

Parametry zapytania:

page (opcjonalny): Numer strony do paginacji.

Domyślnie: 1 (pierwsza strona)
Zasięg: 1 do 200
Zwraca do 50 wpisów dziennika kontroli na stronę
Przykład: ?page=2 aby pobrać drugą stronę

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Uwaga: The kind wskazuje typ rejestrowanej akcji. Typowe wartości obejmują: creation, view, response, close, failed_passphrase, i failed_view.

DELETE /api/v2/requests/:url_token

Natychmiast zamyka żądanie i trwale usuwa wszystkie poufne dane z nim powiązane. Działanie to jest nieodwracalne i nie można go cofnąć. Wymaga uwierzytelnienia i własności.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Zwraca paginowaną listę aktywnych (otwartych lub gotowych) żądań. Wymaga uwierzytelnienia.

GET /api/v2/requests/open

Zwraca stronicowaną listę otwartych żądań. Wymaga uwierzytelnienia.

GET /api/v2/requests/ready

Zwraca podzieloną na strony listę gotowych żądań. Wymaga uwierzytelnienia.

GET /api/v2/requests/closed

Zwraca podzieloną na strony listę zamkniętych żądań. Wymaga uwierzytelnienia.

Parametry zapytania:

page (opcjonalny): Numer strony do paginacji.

Domyślnie: 1 (pierwsza strona)
Zasięg: 1 do 200
Zwraca do 50 żądań na stronę
Przykład: ?page=2 aby pobrać drugą stronę

Państwa wnioskujące

open

Otwarte

Zgłoszenie zostało utworzone i oczekuje na odpowiedź. Tekst żądania jest widoczny, ale nie udzielono jeszcze odpowiedzi.

ready

Gotowy

Na żądanie udzielono odpowiedzi i zawiera ono teraz ładunek odpowiedzi. Tekst żądania nie jest już widoczny, ale odpowiedź jest dostępna do pobrania.

closed

Zamknięte

Żądanie zostało obsłużone, a wszystkie wrażliwe dane (zarówno żądanie, jak i odpowiedź) zostały trwale usunięte. Ten stan jest nieodwracalny.

Przykładowe żądanie (aktywne)

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

Przykładowy wniosek (otwarty)

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

Przykładowe żądanie (gotowe)

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

Przykładowy wniosek (zamknięty)

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

Przykładowa odpowiedź

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

Uwaga: The /active punkt końcowy zwraca żądania w obu open i ready stany. Użycie /open lub /ready aby filtrować według określonego stanu.

Ostatnia aktualizacja: July 20, 2026

Password Pusher API v2

Upraszanie

Żądania mają trzy stany:

Utwórz żądanie

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Wartości czasu trwania dla `close_after_duration`

Przykładowe żądanie

Pobieranie żądania

Przykładowe żądanie

Przykładowe żądanie z hasłem

Przykładowa odpowiedź (otwarte żądanie)

Przykładowa odpowiedź (żądanie gotowości)

Odpowiedź na żądanie

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametry

Podgląd żądania

Przykładowe żądanie

Przykładowa odpowiedź

Pobierz dziennik kontroli żądań

Przykładowe żądanie

Przykładowa odpowiedź

Zamknij żądanie

Przykładowe żądanie

Przykładowa odpowiedź

Żądanie kolekcji

Państwa wnioskujące

Przykładowe żądanie (aktywne)

Przykładowy wniosek (otwarty)

Przykładowe żądanie (gotowe)

Przykładowy wniosek (zamknięty)

Przykładowa odpowiedź

Password Pusher API v2

Upraszanie

Żądania mają trzy stany:

Utwórz żądanie

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Wartości czasu trwania dla close_after_duration

Przykładowe żądanie

Pobieranie żądania

Przykładowe żądanie

Przykładowe żądanie z hasłem

Przykładowa odpowiedź (otwarte żądanie)

Przykładowa odpowiedź (żądanie gotowości)

Odpowiedź na żądanie

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametry

Podgląd żądania

Przykładowe żądanie

Przykładowa odpowiedź

Pobierz dziennik kontroli żądań

Przykładowe żądanie

Przykładowa odpowiedź

Zamknij żądanie

Przykładowe żądanie

Przykładowa odpowiedź

Żądanie kolekcji

Państwa wnioskujące

Przykładowe żądanie (aktywne)

Przykładowy wniosek (otwarty)

Przykładowe żądanie (gotowe)

Przykładowy wniosek (zamknięty)

Przykładowa odpowiedź

Wartości czasu trwania dla `close_after_duration`