Password Pusher API v2
BEETAKattava REST API -dokumentaatio integrointia varten Password Pusher sovelluksiisi
Beta-ilmoitus: API v2 on tällä hetkellä beta-versiossa. Vaikka olemme pyrkineet kaikin tavoin varmistamaan vakauden, ennen lopullista julkaisua saattaa tulla rikkovia muutoksia. Otamme mielellämme vastaan palautetta!
Pyynnöt
Pyynnöt mahdollistavat turvallisen, kaksisuuntaisen viestinnän arkaluonteisten tietojen keräämiseksi. Luo pyyntö salaisella URL-osoitteella, jaa se kenelle tahansa ja vastaanota suojattuja vastauksia, jotka sisältävät tekstiä tai tiedostoja - kaikki ilman, että arkaluonteisia tietoja paljastuu sähköpostissa, chatissa tai lokitiedostoissa.
Täydellinen tapa kerätä tunnistetietoja, API-avaimia, luottamuksellisia asiakirjoja tai muita arkaluonteisia tietoja kollegoilta, asiakkailta tai asiakkailta. Vastaukset salataan automaattisesti ja poistetaan automaattisesti tietyn ajan kuluttua, jotta tietojen altistuminen jää mahdollisimman vähäiseksi. Jokaisen pyynnön audit-lokeissa on saatavilla täydellinen elinkaaren seuranta.
Pyynnöillä on kolme tilaa:
POST /api/v2/requests
Luo uuden pyynnön. Vaatii todennuksen.
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
edellytetään
|
string | Jaettava teksti/viesti |
close_after_duration
valinnainen
|
integer (0-17) | Duration enum - milloin pyyntö suljetaan |
passphrase
valinnainen
|
string | Vaadi vastaanottajia syöttämään tämä salasana nähdäksesi |
name
valinnainen
|
string | Nimi, joka näkyy kojelaudassa, ilmoituksissa ja sähköposteissa |
note
valinnainen
|
string | Sisäinen huomautus (näkyy vain luojalle) |
retrieval_step
valinnainen
|
boolean | Auttaa välttämään chat-järjestelmien ja URL-skannereiden näkymien syömistä |
include_requestor
valinnainen
|
boolean | Pyynnön esittäjän tietojen sisällyttäminen pyyntöön |
response_file_attachments
valinnainen
|
boolean | Salli tiedostojen liitetiedostot vastauksissa |
files
valinnainen
|
array | Pyyntöön ladattavat ja liitettävät tiedostot |
notify_emails_to
valinnainen
|
string | Sähköpostiosoitteet, joille ilmoitetaan, kun pyyntö luodaan (pilkulla erotettuna) |
notify_emails_to_locale
valinnainen
|
string | Paikkakunta (kieli), jolla sähköposti-ilmoitus lähetetään |
authenticated_recipients
valinnainen
|
boolean | Vaatii sähköpostitse lähetetyn kertakäyttöisen salasanan (OTP) vahvistuksen ennen pääsyä. Edellyttää notify_emails_to-asetusta. Toimii vain selaimessa, kun ominaisuus on käytössä (API-kyselyt ja -vastaukset palauttavat virhekoodin 403). |
account_id
valinnainen
|
integer | Tilin tunnus, johon pyyntö liitetään |
Kestoarvot close_after_duration
Esimerkkipyyntö
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
Noudattaa avoimen tai valmiin pyynnön sisällön. Tämä voi sulkea pyynnön, jos se on määritetty sulkeutumaan tietyn määrän katselukertoja jälkeen.
Esimerkkipyyntö
curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a
Esimerkkipyyntö salasanalla
curl -X GET "https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"
Esimerkkivastaus (avoin pyyntö)
{
"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": []
}
Esimerkkivastaus (valmiuspyyntö)
{
"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": []
}
Huom: Jos pyynnössä on salasana, sisällytä se kyselyparametriksi: ?passphrase=your_passphrase. Pyynnön hakeminen lasketaan näkymäksi, ja pyyntö voidaan sulkea, jos se saavuttaa näkymärajan.
PATCH /api/v2/requests/:url_token/respond
Vastaa avoimeen pyyntöön ja muuttaa tilansa tilaksi "valmis".
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][].
Parametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
response
edellytetään
|
string | Vastausteksti/viesti pyyntöön |
files
valinnainen
|
array | Vastaukseen liitettävät tiedostot (vaatii) (vaatii response_file_attachments: true pyynnöstä) |
Huom: Ainoastaan "avoimessa" tilassa olevat pyynnöt voivat vastaanottaa vastauksia. Kun vastaus on lähetetty, pyyntö siirtyy tilaan "valmis", eikä se voi enää vastaanottaa uusia vastauksia.
GET /api/v2/requests/:url_token/preview
Palauttaa pyynnön täydellisesti määritellyn salaisen URL-osoitteen ilman sisällön hakua.
Esimerkkipyyntö
curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview
Esimerkkivastaus
{
"url": "https://us.pwpush.com/r/orpw2wkg00vpn0a"
}
GET /api/v2/requests/:url_token/audit
Palauttaa pyynnön tarkastuslokin. Vaatii todennuksen ja omistajuuden.
Kyselyparametrit:
page (valinnainen): Sivunumero sivunumerointia varten.
- Oletusarvo:
1(ensimmäinen sivu) - Kantama:
1osoitteeseen200 - Palauttaa enintään 50 tarkastuslokimerkintää sivua kohti
- Esimerkki:
?page=2toisen sivun hakemiseksi
Esimerkkipyyntö
curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
{
"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"
}
]
}
Huom: The kind kentässä ilmoitetaan kirjatun toiminnon tyyppi. Yleisiä arvoja ovat mm: creation, view, response, close, failed_passphrase, ja failed_view.
DELETE /api/v2/requests/:url_token
Sulkee pyynnön välittömästi ja poistaa pysyvästi kaikki siihen liittyvät arkaluonteiset tiedot. Tämä toimenpide on peruuttamaton, eikä sitä voi peruuttaa. Vaatii todennuksen ja omistajuuden.
Esimerkkipyyntö
curl -X DELETE https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
{
"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
Palauttaa sivukohtaisen luettelon aktiivisista (avoimista tai valmiista) pyynnöistäsi. Vaatii todennuksen.
GET /api/v2/requests/open
Palauttaa sivukohtaisen luettelon avoimista pyynnöistäsi. Vaatii todennuksen.
GET /api/v2/requests/ready
Palauttaa sivukohtaisen luettelon valmiista pyynnöistäsi. Vaatii todennuksen.
GET /api/v2/requests/closed
Palauttaa sivukohtaisen luettelon suljetuista pyynnöistäsi. Vaatii todennuksen.
Kyselyparametrit:
page (valinnainen): Sivunumero sivunumerointia varten.
- Oletusarvo:
1(ensimmäinen sivu) - Kantama:
1osoitteeseen200 - Palauttaa enintään 50 pyyntöä sivua kohti
- Esimerkki:
?page=2toisen sivun hakemiseksi
Pyyntövaltiot
Pyyntö auki
Pyyntö on luotu ja odottaa vastausta. Pyynnön teksti on näkyvissä, mutta vastausta ei ole vielä annettu.
Valmis
Pyyntöön on vastattu, ja se sisältää nyt vastauksen hyötykuorman. Pyynnön teksti ei ole enää näkyvissä, mutta vastaus on noudettavissa.
Suljettu
Pyyntö on käsitelty ja kaikki arkaluonteiset tiedot (sekä pyyntö että vastaus) on poistettu pysyvästi. Tämä tila on peruuttamaton.
Esimerkkipyyntö (aktiivinen)
curl -X GET https://us.pwpush.com/api/v2/requests/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkipyyntö (avoin)
curl -X GET https://us.pwpush.com/api/v2/requests/open \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkipyyntö (valmis)
curl -X GET https://us.pwpush.com/api/v2/requests/ready \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkipyyntö (suljettu)
curl -X GET https://us.pwpush.com/api/v2/requests/closed \
-H "Authorization: Bearer YOUR_API_TOKEN"
Esimerkkivastaus
[
{
"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
}
]
Huom: The /active päätepiste palauttaa pyynnöt sekä open ja ready valtiot. Käytä /open tai /ready päätepisteet suodattaa tietyn tilan mukaan.
Viimeksi päivitetty: July 20, 2026