Password Pusher API v2
BETAOmfattende REST API-dokumentation til integration Password Pusher ind i dine applikationer
Beta-meddelelse: API v2 er i øjeblikket i beta. Vi har gjort alt for at sikre stabilitet, men der kan forekomme ændringer inden den endelige udgivelse. Vi glæder os over din feedback!
Forespørgsler
Anmodninger muliggør sikker tovejskommunikation til indsamling af følsomme oplysninger. Opret en anmodning med en hemmelig URL, del den med hvem som helst, og modtag sikre svar, der indeholder tekst eller filer - alt sammen uden at eksponere følsomme data i e-mail, chat eller logfiler.
Perfekt til at indsamle legitimationsoplysninger, API-nøgler, fortrolige dokumenter eller andre følsomme oplysninger fra kolleger, klienter eller kunder. Svarene krypteres automatisk og slettes automatisk efter et bestemt tidsrum for at minimere dataeksponeringen. Fuld livscyklussporing er tilgængelig i revisionsloggene for hver anmodning.
Anmodninger har tre tilstande:
POST /api/v2/requests
Opretter en ny anmodning. Kræver godkendelse.
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
påkrævet
|
string | Anmodningsteksten/beskeden, der skal deles |
close_after_duration
valgfri
|
integer (0-17) | Duration enum - hvornår anmodningen skal lukkes |
passphrase
valgfri
|
string | Kræv, at modtagere indtaster denne adgangskode for at se |
name
valgfri
|
string | Et navn, der vises i dashboardet, notifikationer og e-mails |
note
valgfri
|
string | Intern note (kun synlig for skaberen) |
retrieval_step
valgfri
|
boolean | Hjælper med at undgå, at chatsystemer og URL-scannere æder visninger op |
include_requestor
valgfri
|
boolean | Inkluder oplysninger om rekvirenten i anmodningen |
response_file_attachments
valgfri
|
boolean | Tillad vedhæftede filer i svar |
files
valgfri
|
array | Fil(er), der skal uploades og vedhæftes anmodningen |
notify_emails_to
valgfri
|
string | E-mailadresser, der skal have besked, når en anmodning oprettes (kommasepareret) |
notify_emails_to_locale
valgfri
|
string | Lokalitet (sprog) til at sende e-mailmeddelelser i |
account_id
valgfri
|
integer | Det konto-id, som anmodningen skal knyttes til |
Varighedsværdier for close_after_duration
Eksempel på anmodning
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
Henter indholdet af en åben eller klar anmodning. Dette kan lukke anmodningen, hvis den er konfigureret til at lukke efter et bestemt antal visninger.
Eksempel på anmodning
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a
Eksempel på anmodning med adgangssætning
curl -X GET "https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"
Eksempel på svar (åben anmodning)
{
"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": []
}
Eksempel på svar (klar anmodning)
{
"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": []
}
Bemærk: Hvis anmodningen har en passphrase, skal du inkludere den som en forespørgselsparameter: ?passphrase=your_passphrase. At hente en anmodning tæller som en visning og kan lukke anmodningen, hvis den når sin visningsgrænse.
PATCH /api/v2/requests/:url_token/respond
Svarer på en åben anmodning og ændrer sin tilstand til 'klar'.
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 | Type | Beskrivelse |
|---|---|---|
response
påkrævet
|
string | Svarteksten/-beskeden til anmodningen |
files
valgfri
|
array | Fil(er), der skal vedhæftes svaret (kræver response_file_attachments: true på anmodningen) |
Bemærk: Kun anmodninger i tilstanden "åben" kan modtage svar. Når et svar er indsendt, skifter anmodningen til tilstanden "klar" og kan ikke acceptere flere svar.
GET /api/v2/requests/:url_token/preview
Returnerer den fuldt kvalificerede hemmelige URL for en anmodning uden at hente indholdet.
Eksempel på anmodning
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview
Eksempel på svar
{
"url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a"
}
GET /api/v2/requests/:url_token/audit
Returnerer revisionsloggen for en anmodning. Kræver godkendelse og ejerskab.
Forespørgselsparametre:
page (valgfri): Sidenummer til paginering.
- Standard:
1(første side) - Rækkevidde:
1til200 - Returnerer op til 50 revisionslogposter pr. side
- Et eksempel:
?page=2for at hente den anden side
Eksempel på anmodning
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel 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"
}
]
}
Bemærk: Den kind feltet angiver typen af handling, der logges. Almindelige værdier omfatter: creation, view, response, close, failed_passphrase, og failed_view.
DELETE /api/v2/requests/:url_token
Lukker øjeblikkeligt en anmodning og sletter permanent alle følsomme data, der er knyttet til den. Denne handling er irreversibel og kan ikke fortrydes. Kræver godkendelse og ejerskab.
Eksempel på anmodning
curl -X DELETE https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel 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
Returnerer en pagineret liste over dine aktive (åbne eller klar) anmodninger. Kræver godkendelse.
GET /api/v2/requests/open
Returnerer en pagineret liste over dine åbne anmodninger. Kræver godkendelse.
GET /api/v2/requests/ready
Returnerer en pagineret liste over dine klargjorte anmodninger. Kræver godkendelse.
GET /api/v2/requests/closed
Returnerer en pagineret liste over dine lukkede anmodninger. Kræver godkendelse.
Forespørgselsparametre:
page (valgfri): Sidenummer til paginering.
- Standard:
1(første side) - Rækkevidde:
1til200 - Returnerer op til 50 anmodninger pr. side
- Et eksempel:
?page=2for at hente den anden side
Anmodning om stater
Åben
Anmodningen er oprettet og venter på svar. Anmodningsteksten er synlig, men der er endnu ikke givet noget svar.
Parat
Anmodningen er blevet besvaret og indeholder nu svarets payload. Anmodningsteksten er ikke længere synlig, men svaret kan hentes.
Lukket
Anmodningen er blevet håndteret, og alle følsomme data (både anmodning og svar) er blevet slettet permanent. Denne tilstand er irreversibel.
Eksempel på anmodning (aktiv)
curl -X GET https://eu.pwpush.com/api/v2/requests/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på anmodning (åben)
curl -X GET https://eu.pwpush.com/api/v2/requests/open \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på anmodning (klar)
curl -X GET https://eu.pwpush.com/api/v2/requests/ready \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel på anmodning (lukket)
curl -X GET https://eu.pwpush.com/api/v2/requests/closed \
-H "Authorization: Bearer YOUR_API_TOKEN"
Eksempel 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
}
]
Bemærk: Den /active endpoint returnerer anmodninger i både open og ready stater. Brug /open eller /ready slutpunkter for at filtrere efter en bestemt tilstand.
Sidst opdateret: July 12, 2026