Password Pusher API v2
BETAOmfattande REST API-dokumentation för integrering Password Pusher i dina applikationer
Beta Meddelande: API v2 är för närvarande i betaversion. Även om vi har gjort allt för att säkerställa stabilitet kan det förekomma ändringar innan den slutliga utgåvan. Vi välkomnar din feedback!
Förfrågningar
Förfrågningar möjliggör säker tvåvägskommunikation för insamling av känslig information. Skapa en begäran med en hemlig URL, dela den med vem som helst och få säkra svar som innehåller text eller filer - allt utan att exponera känsliga data i e-post, chatt eller loggar.
Perfekt för att samla in autentiseringsuppgifter, API-nycklar, konfidentiella dokument eller annan känslig information från kollegor, klienter eller kunder. Svaren krypteras automatiskt och raderas automatiskt efter en viss tid för att minimera exponeringen av data. Full livscykelspårning finns tillgänglig i granskningsloggarna för varje begäran.
Förfrågningar har tre stater:
POST /api/v2/requests
Skapar en ny begäran. Kräver autentisering.
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
nödvändig
|
string | Begäran om text/meddelande att dela |
close_after_duration
frivillig
|
integer (0-17) | Duration enum - när ska begäran stängas |
passphrase
frivillig
|
string | Kräv att mottagarna anger lösenfrasen för att visa |
name
frivillig
|
string | Ett namn som visas i instrumentpanelen, aviseringar och e-postmeddelanden |
note
frivillig
|
string | Intern anteckning (endast synlig för skaparen) |
retrieval_step
frivillig
|
boolean | Hjälper till att undvika att chattsystem och URL-scanners äter upp visningar |
include_requestor
frivillig
|
boolean | Inkludera information om uppdragsgivaren i begäran |
response_file_attachments
frivillig
|
boolean | Tillåt filbilagor i svar |
files
frivillig
|
array | Fil(er) som ska laddas upp och bifogas till begäran |
notify_emails_to
frivillig
|
string | E-postadresser som ska meddelas när en begäran skapas (kommaseparerade) |
notify_emails_to_locale
frivillig
|
string | Locale (språk) för att skicka e-postmeddelanden i |
account_id
frivillig
|
integer | Det konto-ID som begäran ska kopplas till |
Varaktighet Värden för close_after_duration
Exempel på begäran
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
Hämtar innehållet i en öppen eller klar begäran. Detta kan stänga begäran om den är konfigurerad att stängas efter ett visst antal visningar.
Exempel på begäran
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a
Exempel på begäran med lösenfras
curl -X GET "https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"
Exempel på svar (öppen förfrågan)
{
"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": []
}
Exempel på svar (Ready Request)
{
"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": []
}
Obs! Om begäran innehåller en lösenfras ska den inkluderas som en frågeparameter: ?passphrase=your_passphrase. Att hämta en begäran räknas som en vy och kan stänga begäran om den når sin vygräns.
PATCH /api/v2/requests/:url_token/respond
Svarar på en öppen förfrågan och ändrar sitt tillstånd till "redo".
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][].
Params
| Parameter | Typ | Beskrivning |
|---|---|---|
response
nödvändig
|
string | Svarstexten/meddelandet till begäran |
files
frivillig
|
array | Fil(er) att bifoga till svaret (kräver response_file_attachments: true på begäran) |
Obs! Endast förfrågningar i tillståndet "öppen" kan ta emot svar. När ett svar har skickats övergår begäran till tillståndet "ready" och kan inte ta emot fler svar.
GET /api/v2/requests/:url_token/preview
Returnerar den fullständigt kvalificerade hemliga URL:en för en begäran utan att hämta innehållet.
Exempel på begäran
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview
Exempel på svar
{
"url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a"
}
GET /api/v2/requests/:url_token/audit
Returnerar granskningsloggen för en begäran. Kräver autentisering och ägarskap.
Parametrar för förfrågan:
page (frivillig): Sidnummer för paginering.
- Standard:
1(första sidan) - Range:
1till200 - Returnerar upp till 50 granskningsloggposter per sida
- Exempel:
?page=2för att hämta den andra sidan
Exempel på begäran
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på svar
{
"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"
}
]
}
Obs! Den kind fältet anger vilken typ av åtgärd som loggas. Vanliga värden är t.ex: creation, view, response, close, failed_passphrase, och failed_view.
DELETE /api/v2/requests/:url_token
Stänger omedelbart en begäran och raderar permanent alla känsliga data som är kopplade till den. Denna åtgärd är oåterkallelig och kan inte ångras. Kräver autentisering och ägarskap.
Exempel på begäran
curl -X DELETE https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på svar
{
"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
Returnerar en paginerad lista över dina aktiva (öppna eller klara) förfrågningar. Kräver autentisering.
GET /api/v2/requests/open
Returnerar en paginerad lista över dina öppna förfrågningar. Kräver autentisering.
GET /api/v2/requests/ready
Returnerar en paginerad lista över dina klara förfrågningar. Kräver autentisering.
GET /api/v2/requests/closed
Returnerar en paginerad lista över dina stängda förfrågningar. Kräver autentisering.
Parametrar för förfrågan:
page (frivillig): Sidnummer för paginering.
- Standard:
1(första sidan) - Range:
1till200 - Returnerar upp till 50 förfrågningar per sida
- Exempel:
?page=2för att hämta den andra sidan
Begäran stater
Öppna
Förfrågan har skapats och väntar på svar. Förfrågningstexten är synlig, men inget svar har ännu lämnats.
Redo
Förfrågan har besvarats och innehåller nu svarets nyttolast. Texten i begäran är inte längre synlig, men svaret är tillgängligt för hämtning.
Stängd
Begäran har hanterats och alla känsliga data (både begäran och svar) har raderats permanent. Detta tillstånd är irreversibelt.
Exempel på begäran (aktiv)
curl -X GET https://eu.pwpush.com/api/v2/requests/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på förfrågan (öppen)
curl -X GET https://eu.pwpush.com/api/v2/requests/open \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på begäran (Ready)
curl -X GET https://eu.pwpush.com/api/v2/requests/ready \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på begäran (stängd)
curl -X GET https://eu.pwpush.com/api/v2/requests/closed \
-H "Authorization: Bearer YOUR_API_TOKEN"
Exempel på svar
[
{
"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
}
]
Obs! Den /active endpoint returnerar förfrågningar i både open och ready tillstånd. Använda /open eller /ready slutpunkter för att filtrera efter specifik stat.
Senast uppdaterad: July 12, 2026