Password Pusher एपीआई v2
BETAपासवर्ड पुशर को अपने वर्कफ़्लो, एप्लिकेशन और टूल में एकीकृत करने के लिए व्यापक REST API दस्तावेज़ीकरण।
बीटा सूचना: API v2 वर्तमान में बीटा चरण में है। हमने स्थिरता सुनिश्चित करने के लिए हर संभव प्रयास किया है, फिर भी अंतिम रिलीज़ से पहले कुछ महत्वपूर्ण बदलाव हो सकते हैं। हम आपकी प्रतिक्रिया का स्वागत करते हैं!
अवलोकन
पासवर्ड पुशर एपीआई v2 सुरक्षित पासवर्ड पुश और अनुरोध बनाने, प्राप्त करने और प्रबंधित करने के लिए एक RESTful इंटरफ़ेस प्रदान करता है। सभी एपीआई एंडपॉइंट JSON प्रतिक्रियाएँ लौटाते हैं और मानक HTTP स्टेटस कोड का उपयोग करते हैं।
बियरर टोकन प्रमाणीकरण
टोकन-आधारित प्रमाणीकरण के साथ सुरक्षित API एक्सेस
केवल JSON प्रतिक्रियाएँ
सभी एंडपॉइंट्स पर एक समान JSON प्रारूप
RESTful डिज़ाइन
सर्वोत्तम प्रथाओं का पालन करने वाले सहज REST एंडपॉइंट
पुश और अनुरोध
एकतरफा पुश और दोतरफा अनुरोधों के लिए समर्थन
पासवर्ड जनरेटर
POST /api/v2/generate कमांड का उपयोग करके पासवर्ड, पासफ़्रेज़ और पिन बनाएं।
API v2 बियरर टोकन प्रमाणीकरण का उपयोग करता है। प्रमाणीकरण के लिए, अपने API टोकन को शामिल करें। Authorization शीर्षक:
Authorization: Bearer YOUR_API_TOKEN
अपना एपीआई टोकन प्राप्त करना
- अपने पासवर्ड पुशर खाते में लॉग इन करें
- अपने एपीआई टोकन पेज पर जाएं
- एक एपीआई टोकन जनरेट करें
- टोकन को कॉपी करें और इसे अपने API अनुरोधों में उपयोग करें।
टिप्पणी: कुछ एंडपॉइंट (जैसे पुश या रिक्वेस्ट प्राप्त करना, या पासवर्ड जनरेट करना) को गुमनाम रूप से एक्सेस किया जा सकता है। रिक्वेस्ट बनाना, ऑडिट लॉग एक्सेस करना और कलेक्शन मैनेज करना ऑथेंटिकेशन द्वारा ही संभव है। साइन-इन किए गए वर्कस्पेस पॉलिसी की आवश्यकता होने पर जनरेट रिक्वेस्ट में बियरर टोकन शामिल करें।
सभी API एंडपॉइंट्स के आगे यह उपसर्ग लगा होता है:
https://eu.pwpush.com/api/v2
बीटा उपलब्धता
API v2 वर्तमान में बीटा चरण में है और उपलब्ध है pwpush.com और सेल्फ-होस्टेड प्रो एडिशन। ओपन-सोर्स एडिशन के बीटा चरण से बाहर आने के बाद इसमें एपीआई जोड़ा जाएगा।
सेल्फ-होस्टेड इंस्टेंसेस के लिए, अपने स्वयं के डोमेन का उपयोग करें। ऊपर दिखाया गया बेस यूआरएल उस होस्ट को दर्शाता है जिसे आप वर्तमान में एक्सेस कर रहे हैं।
GET /api/v2/version
यह वर्तमान एपीआई संस्करण, एप्लिकेशन विवरण और एक फ़ीचर हैश लौटाता है जो यह बताता है कि इस इंस्टेंस पर कौन सी क्षमताएं सक्षम हैं।
उदाहरण अनुरोध
curl -X GET https://eu.pwpush.com/api/v2/version
उदाहरण प्रतिक्रिया
{
"application_version": "2.1.0",
"api_version": "2.1",
"edition": "commercial",
"features": {
"anonymous_access": true,
"api_token_authentication": true,
"password_generator": {
"enabled": true,
"languages": ["de", "en", "es", "fr", "it"]
},
"accounts": {
"enabled": true
},
"pushes": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
},
"requests": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
}
}
}
विशेषताएं हैश
अनाम_पहुँच - क्या अनाम एपीआई उपयोग की अनुमति है?
एपीआई_टोकन_प्रमाणीकरण - बियरर टोकन प्रमाणीकरण समर्थन
पासवर्ड_जनरेटर.सक्षम - क्या पासवर्ड, पासफ़्रेज़ और पिन जनरेशन सक्षम है?
पासवर्ड_जनरेटर.भाषाएँ - समर्थित पासफ़्रेज़ शब्द सूची भाषाएँ
खातों को सक्षम किया गया - क्या वर्कस्पेस लिस्टिंग /api/v2/workspaces पर उपलब्ध है (पुराना पथ /api/v2/accounts एक उपनाम है)
पुश सक्षम - एपीआई के माध्यम से पुश का निर्माण और प्रबंधन
pushes.email_auto_dispatch - क्या यह इंस्टेंस बनाते समय गुप्त लिंक ईमेल कर सकता है? यह केवल फ़ीचर डिटेक्शन के लिए है — ऑटो-डिस्पैच से बाहर निकलने के लिए notify_recipients क्रिएट पैरामीटर का उपयोग करें, जबकि प्रमाणित प्राप्तकर्ताओं के लिए notify_emails_to पैरामीटर प्रदान करना जारी रखें।
pushes.file_attachments.enabled - पुश नोटिफिकेशन पर फ़ाइल अटैचमेंट
pushes.file_attachments.requires_authentication - फ़ाइल अटैचमेंट के लिए प्रमाणीकरण आवश्यक है
अनुरोध.सक्षम - API के माध्यम से अनुरोध निर्माण और प्रबंधन
अनुरोध.ईमेल_ऑटो_डिस्पैच - क्या यह इंस्टेंस बनाते समय गुप्त लिंक ईमेल कर सकता है? यह केवल फ़ीचर डिटेक्शन के लिए है — ऑटो-डिस्पैच से बाहर निकलने के लिए notify_recipients क्रिएट पैरामीटर का उपयोग करें, जबकि प्रमाणित प्राप्तकर्ताओं के लिए notify_emails_to पैरामीटर प्रदान करना जारी रखें।
अनुरोध.फ़ाइल_अटैचमेंट.सक्षम - अनुरोध प्रतिक्रियाओं पर फ़ाइल संलग्नक
अनुरोध.फ़ाइल_अटैचमेंट.प्रमाणीकरण_आवश्यकता है - फ़ाइल अटैचमेंट के लिए प्रमाणीकरण आवश्यक है
POST /api/v2/generate
एक या अधिक पासवर्ड, पासफ़्रेज़ या पिन बनाता है। प्रमाणीकरण वैकल्पिक है। अनाम अनुरोध कोर वर्कस्पेस (या स्व-होस्टेड वैश्विक) नीति का उपयोग करते हैं। साइन-इन किए गए वर्कस्पेस नीति का उपयोग करने के लिए बियरर टोकन भेजें, जिसमें कस्टम डोमेन भी शामिल हैं।
जब नीति द्वारा जनरेटर कॉन्फ़िगरेशन अक्षम कर दिया जाता है, तो विकल्प ओवरराइड को अनदेखा कर दिया जाता है और केवल गणना को ही महत्व दिया जाता है।
यदि पासवर्ड जनरेशन अक्षम है, तो एपीआई 403 फॉरबिडन त्रुटि लौटाता है।
प्रति आईपी पते या प्रमाणित उपयोगकर्ता के लिए प्रति मिनट अनुरोधों की संख्या 30 तक सीमित है।
अनुरोध का मुख्य भाग (JSON)
JSON ऑब्जेक्ट के मूल में पैरामीटर भेजें। छोड़े गए फ़ील्ड प्रभावी नीति डिफ़ॉल्ट मानों पर वापस आ जाते हैं।
| पैरामीटर | प्रकार | विवरण |
|---|---|---|
workspace_id
वैकल्पिक
|
string | नीति लागू करने के लिए प्रमाणित कार्यक्षेत्र। यह खाता आईडी भी स्वीकार करता है। यदि कॉल करने वाला उस कार्यक्षेत्र का सदस्य नहीं है, तो 401 त्रुटि लौटाता है। |
type
वैकल्पिक
|
string | पासवर्ड, पासफ़्रेज़ या पिन |
count
वैकल्पिक
|
integer (1-10) | उत्पन्न किए जाने वाले मानों की संख्या |
language
वैकल्पिक
|
string | पासफ़्रेज़ शब्द सूची: en, es, fr, de, या it |
word_count
वैकल्पिक
|
integer (3-10) | पासफ़्रेज़ में शब्दों की संख्या |
separator
वैकल्पिक
|
string | पासफ़्रेज़ शब्दों के बीच स्ट्रिंग डाली गई |
capitalize
वैकल्पिक
|
boolean | पासफ़्रेज़ के प्रत्येक शब्द का पहला अक्षर कैपिटल करें |
number
वैकल्पिक
|
boolean | पासफ़्रेज़ में अंक जोड़ें |
symbol
वैकल्पिक
|
boolean | पासफ़्रेज़ में एक प्रतीक जोड़ें |
length
वैकल्पिक
|
integer | पासवर्ड की लंबाई (4–128) या पिन की लंबाई (4–12) |
uppercase
वैकल्पिक
|
boolean | पासवर्ड में बड़े अक्षरों का प्रयोग करें। |
lowercase
वैकल्पिक
|
boolean | पासवर्ड में छोटे अक्षरों का प्रयोग करें। |
digits
वैकल्पिक
|
boolean | पासवर्ड में अंक शामिल करें |
symbols
वैकल्पिक
|
boolean | पासवर्ड में प्रतीकों का उपयोग करें |
avoid_ambiguous
वैकल्पिक
|
boolean | 0, O, l और 1 जैसे अस्पष्ट वर्णों को शामिल न करें। |
min_digits
वैकल्पिक
|
integer | पासवर्ड में अंकों की न्यूनतम संख्या |
min_symbols
वैकल्पिक
|
integer | पासवर्ड में प्रतीकों की न्यूनतम संख्या |
charset
वैकल्पिक
|
string | अक्षर पूर्व निर्धारित: ASCII, लैटिन, सिरिलिक या ग्रीक। किसी भी अन्य मान को कस्टम कैरेक्टर पूल के रूप में माना जाता है। |
प्रतिक्रिया क्षेत्र
| मैदान | विवरण |
|---|---|
type |
पासवर्ड, पासफ़्रेज़ या पिन |
language |
पासफ़्रेज़ के लिए मौजूद। परिणाम उत्पन्न करने के लिए उपयोग की गई शब्द सूची। |
entropy_bits |
प्रतिक्रिया में अनुमानित शक्ति वापस आ गई। देखें पासवर्ड की मजबूती मापने के लिए एंट्रॉपी का उपयोग. |
results |
उत्पन्न स्ट्रिंगों का ऐरे |
उदाहरण अनुरोध
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Content-Type: application/json" \
-d '{
"type": "passphrase",
"language": "en",
"word_count": 4,
"count": 2
}'
उदाहरण प्रतिक्रिया
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
पासवर्ड का उदाहरण
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "password",
"length": 20,
"symbols": true
}'
उदाहरण: पुश नोटिफिकेशन बनाएं और प्राप्त करें
# Create a push
curl -X POST https://eu.pwpush.com/api/v2/pushes \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"push": {
"payload": "MySecretPassword123",
"expire_after_duration": 6,
"expire_after_views": 3
}
}'
# Retrieve the push
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
उदाहरण: अनुरोध बनाएं और प्रतिक्रिया दें
# Create a request
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 the API key",
"close_after_duration": 8
}
}'
# Respond to the request
curl -X PATCH https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
-H "Content-Type: application/json" \
-d '{
"request": {
"response": "The API key is: sk_live_1234567890"
}
}'
अनुरोध राज्य
यह एपीआई मानक HTTP स्टेटस कोड का उपयोग करता है:
200 OK
अनुरोध सफल रहा
201 Created
संसाधन निर्मित
400 Bad Request
अमान्य मापदण्ड
422 Unprocessable Entity
सत्यापन त्रुटियाँ या अमान्य अनुरोध डेटा
401 Unauthorized
प्रमाणित करना
403 Forbidden
पहुंच अस्वीकृत
404 Not Found
संसाधन नहीं मिला
API के दुरुपयोग से सुरक्षा और सभी उपयोगकर्ताओं के लिए उचित उपयोग सुनिश्चित करने के लिए दर सीमा लागू की गई है। दर सीमा प्रत्येक IP पते पर लागू होती है और अनुरोध के प्रकार और एंडपॉइंट के आधार पर भिन्न होती है।
ऑडिट लॉग GET अनुरोध प्रति आईपी प्रति मिनट 15 अनुरोधों तक सीमित हैं, जिसमें प्रति 10 सेकंड में 5 अनुरोधों की बर्स्ट सीमा और प्रति प्रमाणित उपयोगकर्ता या एपीआई टोकन प्रति मिनट 30 अनुरोधों की सीमा है।
दर सीमा प्रतिक्रियाएँ
जब कोई अनुरोध दर सीमा से अधिक हो जाता है, तो एपीआई एक त्रुटि लौटाता है। 429 Too Many Requests एक स्टेटस कोड के साथ Retry-After यह हेडर दर्शाता है कि आप अनुरोध को कब दोबारा प्रयास कर सकते हैं।
सर्वोत्तम प्रथाएं
- 429 प्रतिक्रिया प्राप्त होने पर एक्सपोनेंशियल बैकऑफ़ लागू करें।
- सम्मान करें
Retry-Afterहेडर मान - API कॉल को कम करने के लिए आवश्यकतानुसार रिस्पॉन्स को कैश करें।
- जहां संभव हो, कई अलग-अलग अनुरोध करने के बजाय बैच ऑपरेशन करें।
- अपनी एप्लिकेशन के API उपयोग की निगरानी करें ताकि सीमा का उल्लंघन न हो।
टिप्पणी: रेट लिमिट का उद्देश्य दुरुपयोग को रोकना और वैध उपयोग की अनुमति देना है। यदि आपको लगातार रेट लिमिट की समस्या आ रही है, तो अपने इंटीग्रेशन को ऑप्टिमाइज़ करने पर विचार करें या अपने उपयोग के मामले पर चर्चा करने के लिए सपोर्ट से संपर्क करें।
आखरी अपडेट: November 22, 2026