Password Pusher API верзије 2
БЕТАСвеобухватна REST API документација за интеграцију Password Pusher у ваше апликације
Обавештење о бета верзији: API v2 је тренутно у бета верзији. Иако смо уложили све напоре да обезбедимо стабилност, могуће су значајне промене пре финалног издања. Ценимо ваше повратне информације!
Захтеви
Захтеви омогућавају безбедну, двосмерну комуникацију за прикупљање осетљивих информација. Направите захтев са тајним URL-ом, поделите га са било ким и примајте безбедне одговоре који садрже текст или датотеке – све без откривања осетљивих података у е-пошти, ћаскању или логовима.
Идеално за прикупљање акредитива, API кључева, поверљивих докумената или било којих осетљивих информација од колега, клијената или купаца. Одговори се аутоматски шифрују и аутоматски бришу након одређеног периода како би се минимизирала изложеност подацима. Праћење целог животног циклуса је доступно у евиденцијама ревизије сваког захтева.
Захтеви имају три стања:
POST /api/v2/requests
Креира нови захтев. Захтева аутентификацију.
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
потребан
|
string | Текст/порука захтева за дељење |
close_after_duration
опционо
|
integer (0-17) | Трајање - када затворити захтев |
passphrase
опционо
|
string | Захтевајте од прималаца да унесу ову лозинку да би видели |
name
опционо
|
string | Име приказано на контролној табли, у обавештењима и имејловима |
note
опционо
|
string | Интерна напомена (видљива само аутору) |
retrieval_step
опционо
|
boolean | Помаже у спречавању да системи за ћаскање и скенери URL-ова „поједу“ прегледе |
include_requestor
опционо
|
boolean | У захтев уврстите информације о подносиоцу захтева |
response_file_attachments
опционо
|
boolean | Дозволи прилоге датотека у одговорима |
files
опционо
|
array | Датотека(е) за отпремање и прилагање уз захтев |
notify_emails_to
опционо
|
string | Имејл адресе које ће бити обавештене када се захтев креира (раздвојене зарезима) |
notify_emails_to_locale
опционо
|
string | Локалитет (језик) за слање обавештења е-поштом |
account_id
опционо
|
integer | ИД налога са којим треба повезати захтев |
Вредности трајања за close_after_duration
Пример захтева
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
Преузима садржај отвореног или спремног захтева. Ово може затворити захтев ако је конфигурисано да се затвори након одређеног броја прегледа.
Пример захтева
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a
Пример захтева са лозинком
curl -X GET "https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"
Пример одговора (Отворени захтев)
{
"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": []
}
Пример одговора (захтев за спремност)
{
"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": []
}
Напомена: Ако захтев има лозинку, укључите је као параметар упита: ?passphrase=your_passphrase. Преузимање захтева се рачуна као преглед и може затворити захтев ако достигне ограничење прегледа.
PATCH /api/v2/requests/:url_token/respond
Одговара на отворени захтев, мењајући своје стање у „спремно“.
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][].
Парамс
| Параметар | Tip | Опис |
|---|---|---|
response
потребан
|
string | Текст/порука одговора на захтев |
files
опционо
|
array | Датотека(е) за прилагање уз одговор (потребно response_file_attachments: true на захтев) |
Напомена: Само захтеви у стању „отворено“ могу да примају одговоре. Када се одговор пошаље, захтев прелази у стање „спреман“ и не може да прихвати додатне одговоре.
GET /api/v2/requests/:url_token/preview
Враћа потпуно квалификовану тајну URL адресу захтева без преузимања садржаја.
Пример захтева
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview
Пример одговора
{
"url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a"
}
GET /api/v2/requests/:url_token/audit
Враћа дневник ревизије за захтев. Захтева аутентификацију и власништво.
Параметри упита:
page (опционо): Број странице за пагинацију.
- Подразумевано:
1(прва страница) - Распон:
1до200 - Враћа до 50 уноса у дневник ревизије по страници
- Пример:
?page=2да преузмете другу страницу
Пример захтева
curl -X GET https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример одговора
{
"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"
}
]
}
Напомена: The kind Поље означава врсту забележене радње. Уобичајене вредности укључују: creation, view, response, close, failed_passphrase, и failed_view.
DELETE /api/v2/requests/:url_token
Одмах затвара захтев и трајно брише све осетљиве податке повезане са њим. Ова радња је неповратна и не може се поништити. Захтева аутентификацију и власништво.
Пример захтева
curl -X DELETE https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример одговора
{
"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
Враћа пагинирану листу ваших активних (отворених или спремних) захтева. Захтева аутентификацију.
GET /api/v2/requests/open
Враћа пагинирану листу ваших отворених захтева. Захтева аутентификацију.
GET /api/v2/requests/ready
Враћа пагинирану листу ваших спремних захтева. Захтева аутентификацију.
GET /api/v2/requests/closed
Враћа пагинирану листу ваших затворених захтева. Захтева аутентификацију.
Параметри упита:
page (опционо): Број странице за пагинацију.
- Подразумевано:
1(прва страница) - Распон:
1до200 - Враћа до 50 захтева по страници
- Пример:
?page=2да преузмете другу страницу
Захтевне државе
Otvoreno
Захтев је креиран и чека одговор. Текст захтева је видљив, али још увек није дат одговор.
Спреман
На захтев је одговорено и сада садржи садржај одговора. Текст захтева више није видљив, али је одговор доступан за преузимање.
Затворено
Захтев је обрађен и сви осетљиви подаци (и захтев и одговор) су трајно избрисани. Ово стање је неповратно.
Пример захтева (активан)
curl -X GET https://eu.pwpush.com/api/v2/requests/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример захтева (Отворено)
curl -X GET https://eu.pwpush.com/api/v2/requests/open \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример захтева (спремно)
curl -X GET https://eu.pwpush.com/api/v2/requests/ready \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример захтева (затворено)
curl -X GET https://eu.pwpush.com/api/v2/requests/closed \
-H "Authorization: Bearer YOUR_API_TOKEN"
Пример одговора
[
{
"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
}
]
Напомена: The /active крајња тачка враћа захтеве у оба open и ready државе. Користите /open или /ready крајње тачке за филтрирање по одређеном стању.
Последње ажурирање: July 12, 2026