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!

Pieprasījumi

Pieprasījumi nodrošina drošu divvirzienu saziņu sensitīvas informācijas vākšanai. Izveidojiet pieprasījumu ar slepenu URL, kopīgojiet to ar jebkuru personu un saņemiet drošas atbildes ar tekstu vai failiem - un tas viss bez sensitīvu datu izpaušanas e-pastā, tērzēšanā vai žurnālos.

Ideāli piemērots akreditācijas datu, API atslēgu, konfidenciālu dokumentu vai jebkuras konfidenciālas informācijas vākšanai no kolēģiem, klientiem vai klientiem. Atbildes tiek automātiski šifrētas un automātiski izdzēstas pēc noteikta laika, lai samazinātu datu izpaušanu. Pilna dzīves cikla izsekošana ir pieejama katra pieprasījuma audita žurnālos.

Pieprasījumiem ir trīs stāvokļi:

open Pieprasījums ir izveidots un gaida atbildi. Kopīgojiet pieprasījuma URL ar saņēmēju.

ready Atbilde ir sniegta un ir pieejama, lai to varētu saņemt. Sākotnējais pieprasītājs tagad var piekļūt atbildei.

closed Pieprasījuma termiņš ir beidzies vai tas ir manuāli slēgts. Visi sensitīvie dati ir neatgriezeniski dzēsti.

POST /api/v2/requests

Izveido jaunu pieprasījumu. Nepieciešama autentifikācija.

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` obligāts	string	Kopīgojamais pieprasījuma teksts/ziņojums
`close_after_duration` neobligāts	integer (0-17)	Ilguma enum - kad slēgt pieprasījumu
`passphrase` neobligāts	string	Pieprasīt saņēmējiem ievadīt šo piekļuves frāzi, lai skatītu
`name` neobligāts	string	Vārds, kas redzams paneļa paneļos, paziņojumos un e-pasta ziņojumos
`note` neobligāts	string	Iekšēja piezīme (redzama tikai autoram)
`retrieval_step` neobligāts	boolean	Palīdz izvairīties no tā, ka tērzēšanas sistēmas un URL skeneri apēd skatījumus
`include_requestor` neobligāts	boolean	Pieprasījumā iekļaujiet pieprasītāja informāciju
`response_file_attachments` neobligāts	boolean	Atļaut failu pielikumus atbildēs
`files` neobligāts	array	Failu(-us), ko augšupielādēt un pievienot pieprasījumam
`notify_emails_to` neobligāts	string	E-pasta adreses, kas tiks informētas, kad pieprasījums ir izveidots (atdalītas komatā)
`notify_emails_to_locale` neobligāts	string	Vietne (valoda), kurā sūtīt e-pasta paziņojumu(-us)
`authenticated_recipients` neobligāts	boolean	Pirms piekļuves ir nepieciešama apstiprināšana ar vienreizējo paroli (OTP), kas nosūtīta uz e-pastu. Nepieciešams iestatījums „notify_emails_to“. Ja šī funkcija ir ieslēgta, tā darbojas tikai pārlūkprogrammā (API izsaukums/atbilde atgriež kļūdu 403).
`account_id` neobligāts	integer	Konta ID, ar kuru saistīt pieprasījumu

Ilgums Vērtības `close_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

Pieprasījuma piemērs

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

Atgūst atvērtā vai gatavā pieprasījuma saturu. Tas var slēgt pieprasījumu, ja tas ir konfigurēts tā slēgšanai pēc noteikta skatījumu skaita.

Pieprasījuma piemērs

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

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

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

Atbildes piemērs (atklātais pieprasījums)

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

Atbildes piemērs (gatavs pieprasījums)

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

Piezīme: Ja pieprasījumā ir parole, iekļaujiet to kā vaicājuma parametru: ?passphrase=your_passphrase. Pieprasījuma atgūšana tiek uzskatīta par skatījumu, un, ja tiek sasniegts skatījumu limits, pieprasījums var tikt slēgts.

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

Atbild uz atvērtu pieprasījumu, mainot tā stāvokli uz "gatavs".

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

Parametri

Parametrs	Tips	Apraksts
`response` obligāts	string	Atbildes teksts/ziņojums uz pieprasījumu
`files` neobligāts	array	Datne(-es), kas jāpievieno atbildei (nepieciešama(-as) `response_file_attachments: true` pieprasījumā)

Piezīme: Atbildes var saņemt tikai uz pieprasījumiem, kas ir atvērtā stāvoklī. Kad atbilde ir iesniegta, pieprasījums pāriet "gatavs" stāvoklī un nevar pieņemt papildu atbildes.

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

Atgriež pieprasījuma pilnībā kvalificētu slepeno URL, neiegūstot saturu.

Pieprasījuma piemērs

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

Atbildes piemērs

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

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

Atgriež pieprasījuma revīzijas žurnālu. 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://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/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"
    },
    {
      "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"
    }
  ]
}

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

DELETE /api/v2/requests/:url_token

Tūlīt aizver pieprasījumu un neatgriezeniski dzēš visus ar to saistītos sensitīvos datus. Šī darbība ir neatgriezeniska, un to nevar atcelt. Nepieciešama autentifikācija un īpašumtiesības.

Pieprasījuma piemērs

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

Atbildes piemērs

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

Atgriež jūsu aktīvo (atvērto vai gatavo) pieprasījumu sarakstu ar lapām. Nepieciešama autentifikācija.

GET /api/v2/requests/open

Atgriež atvērto pieprasījumu sarakstu ar lapām. Nepieciešama autentifikācija.

GET /api/v2/requests/ready

Atgriež jūsu gatavo pieprasījumu sarakstu ar lapiņām. Nepieciešama autentifikācija.

GET /api/v2/requests/closed

Atgriež jūsu slēgto pieprasījumu sarakstu ar lappusēm. 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 pieprasījumiem vienā lapā
Piemērs: ?page=2 lai iegūtu otro lapu

Pieprasījums valstis

open

Atvērt

Pieprasījums ir izveidots un gaida atbildi. Pieprasījuma teksts ir redzams, bet atbilde vēl nav sniegta.

ready

Atbilde gatava

Uz pieprasījumu ir sniegta atbilde, un tagad tajā ir iekļauta atbildes ielāde. Pieprasījuma teksts vairs nav redzams, bet atbilde ir pieejama izgūšanai.

closed

Slēgts

Pieprasījums ir apstrādāts, un visi sensitīvie dati (gan pieprasījums, gan atbilde) ir neatgriezeniski dzēsti. Šis stāvoklis ir neatgriezenisks.

Pieprasījuma piemērs (aktīvs)

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

Pieprasījuma piemērs (atvērts)

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

Pieprasījuma piemērs (gatavs)

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

Pieprasījuma piemērs (slēgts)

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

Atbildes piemērs

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

Piezīme: Portāls /active galapunkts atgriež pieprasījumus gan open un ready valstis. Izmantojiet /open vai /ready galapunktus, lai filtrētu pēc konkrēta stāvokļa.

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

Password Pusher API v2

Pieprasījumi

Pieprasījumiem ir trīs stāvokļi:

Izveidot pieprasījumu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Ilgums Vērtības `close_after_duration`

Pieprasījuma piemērs

Pieprasījuma atgūšana

Pieprasījuma piemērs

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

Atbildes piemērs (atklātais pieprasījums)

Atbildes piemērs (gatavs pieprasījums)

Atbildēt uz pieprasījumu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametri

Pieprasījuma priekšskatījums

Pieprasījuma piemērs

Atbildes piemērs

Saņemt pieprasījumu audita žurnālu

Pieprasījuma piemērs

Atbildes piemērs

Pieprasījuma slēgšana

Pieprasījuma piemērs

Atbildes piemērs

Pieprasīt kolekcijas

Pieprasījums valstis

Pieprasījuma piemērs (aktīvs)

Pieprasījuma piemērs (atvērts)

Pieprasījuma piemērs (gatavs)

Pieprasījuma piemērs (slēgts)

Atbildes piemērs

Password Pusher API v2

Pieprasījumi

Pieprasījumiem ir trīs stāvokļi:

Izveidot pieprasījumu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Ilgums Vērtības close_after_duration

Pieprasījuma piemērs

Pieprasījuma atgūšana

Pieprasījuma piemērs

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

Atbildes piemērs (atklātais pieprasījums)

Atbildes piemērs (gatavs pieprasījums)

Atbildēt uz pieprasījumu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametri

Pieprasījuma priekšskatījums

Pieprasījuma piemērs

Atbildes piemērs

Saņemt pieprasījumu audita žurnālu

Pieprasījuma piemērs

Atbildes piemērs

Pieprasījuma slēgšana

Pieprasījuma piemērs

Atbildes piemērs

Pieprasīt kolekcijas

Pieprasījums valstis

Pieprasījuma piemērs (aktīvs)

Pieprasījuma piemērs (atvērts)

Pieprasījuma piemērs (gatavs)

Pieprasījuma piemērs (slēgts)

Atbildes piemērs

Ilgums Vērtības `close_after_duration`