Password Pusher एपीआई v2
बीटाएकीकरण के लिए व्यापक REST API दस्तावेज़ीकरण Password Pusher अपने आवेदनों में
बीटा सूचना: API v2 वर्तमान में बीटा चरण में है। हमने स्थिरता सुनिश्चित करने के लिए हर संभव प्रयास किया है, फिर भी अंतिम रिलीज़ से पहले कुछ महत्वपूर्ण बदलाव हो सकते हैं। हम आपकी प्रतिक्रिया का स्वागत करते हैं!
अनुरोध
अनुरोध संवेदनशील जानकारी एकत्र करने के लिए सुरक्षित, दो-तरफ़ा संचार को सक्षम बनाते हैं। एक गुप्त URL के साथ अनुरोध बनाएं, इसे किसी के साथ भी साझा करें, और ईमेल, चैट या लॉग में संवेदनशील डेटा को उजागर किए बिना टेक्स्ट या फ़ाइलों वाले सुरक्षित उत्तर प्राप्त करें।
सहकर्मियों, ग्राहकों या उपभोक्ताओं से क्रेडेंशियल, एपीआई कुंजी, गोपनीय दस्तावेज़ या कोई भी संवेदनशील जानकारी एकत्र करने के लिए यह एकदम सही है। डेटा लीक को कम करने के लिए प्रतिक्रियाएं स्वचालित रूप से एन्क्रिप्ट की जाती हैं और एक निश्चित अवधि के बाद स्वतः हटा दी जाती हैं। प्रत्येक अनुरोध के ऑडिट लॉग में संपूर्ण जीवनचक्र ट्रैकिंग उपलब्ध है।
अनुरोधों की तीन अवस्थाएँ होती हैं:
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://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
आवश्यक
|
string | साझा करने के लिए अनुरोधित पाठ/संदेश |
close_after_duration
वैकल्पिक
|
integer (0-17) | अवधि एनम - अनुरोध को कब बंद करना है |
passphrase
वैकल्पिक
|
string | प्राप्तकर्ताओं को इसे देखने के लिए यह पासफ़्रेज़ दर्ज करना आवश्यक है। |
name
वैकल्पिक
|
string | डैशबोर्ड, सूचनाओं और ईमेल में दिखाया जाने वाला नाम |
note
वैकल्पिक
|
string | आंतरिक नोट (केवल निर्माता को दिखाई देगा) |
retrieval_step
वैकल्पिक
|
boolean | यह चैट सिस्टम और यूआरएल स्कैनर द्वारा व्यूज को कम होने से बचाने में मदद करता है। |
include_requestor
वैकल्पिक
|
boolean | अनुरोध में अनुरोधकर्ता की जानकारी शामिल करें |
response_file_attachments
वैकल्पिक
|
boolean | प्रतिक्रियाओं में फ़ाइल अटैचमेंट की अनुमति दें |
files
वैकल्पिक
|
array | अनुरोध के साथ अपलोड और संलग्न करने के लिए फ़ाइलें |
notify_emails_to
वैकल्पिक
|
string | अनुरोध बनने पर सूचित किए जाने वाले ईमेल पते (अल्पविराम से अलग किए गए) |
notify_emails_to_locale
वैकल्पिक
|
string | ईमेल सूचनाएं भेजने के लिए स्थान (भाषा) |
authenticated_recipients
वैकल्पिक
|
boolean | एक्सेस करने से पहले ईमेल ओटीपी सत्यापन आवश्यक है। इसके लिए notify_emails_to आवश्यक है। सक्षम होने पर यह केवल ब्राउज़र में ही काम करता है (एपीआई रिट्रीव/रिस्पॉन्ड करने पर 403 त्रुटि आती है)। |
account_id
वैकल्पिक
|
integer | अनुरोध को संबद्ध करने के लिए खाता आईडी |
अवधि मानों के लिए close_after_duration
उदाहरण अनुरोध
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
किसी खुली या तैयार रिक्वेस्ट की सामग्री को पुनः प्राप्त करता है। यदि इसे निश्चित संख्या में देखे जाने के बाद बंद होने के लिए कॉन्फ़िगर किया गया है, तो यह रिक्वेस्ट को बंद कर सकता है।
उदाहरण अनुरोध
curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a
पासफ़्रेज़ के साथ अनुरोध का उदाहरण
curl -X GET "https://us.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://us.pwpush.com/r/orpw2wkg00vpn0a.json",
"html_url": "https://us.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://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": []
}
टिप्पणी: यदि अनुरोध में पासफ़्रेज़ है, तो उसे क्वेरी पैरामीटर के रूप में शामिल करें: ?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://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][].
पैरामीटर
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
response
आवश्यक
|
string | अनुरोध के जवाब में भेजा गया संदेश/पाठ |
files
वैकल्पिक
|
array | प्रतिक्रिया के साथ संलग्न करने के लिए फ़ाइलें (आवश्यकताएँ) response_file_attachments: true अनुरोध पर) |
टिप्पणी: केवल "खुली" स्थिति में मौजूद अनुरोध ही प्रतिक्रियाएँ प्राप्त कर सकते हैं। एक बार प्रतिक्रिया सबमिट हो जाने पर, अनुरोध "तैयार" स्थिति में चला जाता है और आगे कोई प्रतिक्रिया स्वीकार नहीं कर सकता।
GET /api/v2/requests/:url_token/preview
यह अनुरोध की सामग्री को पुनर्प्राप्त किए बिना, अनुरोध का पूर्ण रूप से योग्य गुप्त URL लौटाता है।
उदाहरण अनुरोध
curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview
उदाहरण प्रतिक्रिया
{
"url": "https://us.pwpush.com/r/orpw2wkg00vpn0a"
}
GET /api/v2/requests/:url_token/audit
किसी अनुरोध के लिए ऑडिट लॉग लौटाता है। प्रमाणीकरण और स्वामित्व आवश्यक है।
क्वेरी पैरामीटर:
page (वैकल्पिक): पृष्ठ संख्या निर्धारण के लिए पृष्ठ संख्या।
- गलती करना:
1(पहला पृष्ठ) - श्रेणी:
1को200 - प्रति पृष्ठ अधिकतम 50 ऑडिट लॉग प्रविष्टियाँ लौटाता है
- उदाहरण:
?page=2दूसरा पृष्ठ प्राप्त करने के लिए
उदाहरण अनुरोध
curl -X GET https://us.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://us.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://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
यह आपके सक्रिय (खुले या तैयार) अनुरोधों की एक पृष्ठबद्ध सूची लौटाता है। प्रमाणीकरण आवश्यक है।
GET /api/v2/requests/open
यह आपके खुले अनुरोधों की एक पृष्ठबद्ध सूची लौटाता है। प्रमाणीकरण आवश्यक है।
GET /api/v2/requests/ready
यह आपके तैयार अनुरोधों की एक पृष्ठबद्ध सूची लौटाता है। प्रमाणीकरण आवश्यक है।
GET /api/v2/requests/closed
यह आपके बंद किए गए अनुरोधों की एक पृष्ठबद्ध सूची लौटाता है। इसके लिए प्रमाणीकरण आवश्यक है।
क्वेरी पैरामीटर:
page (वैकल्पिक): पृष्ठ संख्या निर्धारण के लिए पृष्ठ संख्या।
- गलती करना:
1(पहला पृष्ठ) - श्रेणी:
1को200 - प्रति पृष्ठ अधिकतम 50 अनुरोध लौटाता है
- उदाहरण:
?page=2दूसरा पृष्ठ प्राप्त करने के लिए
अनुरोध राज्य
खुला
अनुरोध तैयार हो चुका है और प्रतिक्रिया की प्रतीक्षा कर रहा है। अनुरोध का पाठ दिखाई दे रहा है, लेकिन अभी तक कोई प्रतिक्रिया नहीं मिली है।
तैयार
अनुरोध का जवाब दे दिया गया है और अब इसमें प्रतिक्रिया पेलोड शामिल है। अनुरोध का पाठ अब दिखाई नहीं दे रहा है, लेकिन प्रतिक्रिया प्राप्त करने के लिए उपलब्ध है।
बंद किया हुआ
अनुरोध पर कार्रवाई पूरी हो चुकी है और सभी संवेदनशील डेटा (अनुरोध और प्रतिक्रिया दोनों) स्थायी रूप से हटा दिए गए हैं। यह स्थिति अपरिवर्तनीय है।
उदाहरण अनुरोध (सक्रिय)
curl -X GET https://us.pwpush.com/api/v2/requests/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
उदाहरण अनुरोध (खुला)
curl -X GET https://us.pwpush.com/api/v2/requests/open \
-H "Authorization: Bearer YOUR_API_TOKEN"
उदाहरण अनुरोध (तैयार)
curl -X GET https://us.pwpush.com/api/v2/requests/ready \
-H "Authorization: Bearer YOUR_API_TOKEN"
उदाहरण अनुरोध (बंद)
curl -X GET https://us.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://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
}
]
टिप्पणी: The /active एंडपॉइंट दोनों ही तरह से अनुरोध लौटाता है। open और ready राज्यों का उपयोग करें /open या /ready विशिष्ट राज्य के आधार पर फ़िल्टर करने के लिए एंडपॉइंट।
आखरी अपडेट: July 20, 2026