Password Pusher API เวอร์ชัน 2
BETAเอกสารประกอบการใช้งาน REST API อย่างครบถ้วน เพื่อใช้ในการผสานรวม Password Pusher เข้ากับเวิร์กโฟลว์ แอปพลิเคชัน และเครื่องมือของคุณ
ประกาศสำหรับรุ่นเบต้า: API เวอร์ชัน 2 ขณะนี้อยู่ในช่วงเบต้า แม้ว่าเราจะพยายามอย่างเต็มที่เพื่อให้มั่นใจถึงความเสถียรแล้ว แต่ก็อาจมีการเปลี่ยนแปลงที่ส่งผลกระทบต่อการทำงานก่อนการเปิดตัวเวอร์ชันเต็ม เรายินดีรับฟังความคิดเห็นของคุณ!
ภาพรวม
Password Pusher API เวอร์ชัน 2 มีอินเทอร์เฟซแบบ RESTful สำหรับสร้าง ดึงข้อมูล และจัดการการส่งและการร้องขอรหัสผ่านอย่างปลอดภัย ปลายทาง API ทั้งหมดส่งคืนการตอบสนองในรูปแบบ JSON และใช้รหัสสถานะ HTTP มาตรฐาน
การตรวจสอบสิทธิ์ด้วย Bearer Token
การเข้าถึง API ที่ปลอดภัยด้วยการตรวจสอบสิทธิ์แบบใช้โทเค็น
การตอบสนองแบบ JSON เท่านั้น
รูปแบบ JSON ที่สอดคล้องกันในทุกเอนด์พอยต์
การออกแบบ RESTful
เอนด์พอยต์ REST ที่ใช้งานง่ายตามหลักปฏิบัติที่ดีที่สุด
พุชและคำขอ
รองรับการส่งข้อมูลทางเดียวและการร้องขอสองทาง
ตัวสร้างรหัสผ่าน
สร้างรหัสผ่าน วลีรหัสผ่าน และรหัส PIN ผ่าน POST /api/v2/generate
API เวอร์ชัน 2 ใช้การตรวจสอบสิทธิ์ด้วยโทเค็น Bearer ในการตรวจสอบสิทธิ์ ให้ใส่โทเค็น API ของคุณลงในข้อมูลที่ระบุ Authorization ส่วนหัว:
Authorization: Bearer YOUR_API_TOKEN
การรับโทเค็น API ของคุณ
- เข้าสู่ระบบบัญชี Password Pusher ของคุณ
- ไปที่หน้าโทเค็น API ของคุณ
- สร้างโทเค็น API
- คัดลอกโทเค็นและนำไปใช้ในคำขอ API ของคุณ
บันทึก: บางเอนด์พอยต์ (เช่น การดึงข้อมูลพุชหรือคำขอ หรือการสร้างรหัสผ่าน) สามารถเข้าถึงได้โดยไม่ระบุตัวตน การสร้างคำขอ การเข้าถึงบันทึกการตรวจสอบ และการจัดการคอลเลกชันจำเป็นต้องมีการตรวจสอบสิทธิ์ ควรใส่โทเค็น Bearer ในการสร้างคำขอเมื่อคุณต้องการใช้สิทธิ์การเข้าถึงพื้นที่ทำงานแบบลงชื่อเข้าใช้
เอนด์พอยต์ API ทั้งหมดจะมีคำนำหน้าดังนี้:
https://eu.pwpush.com/api/v2
เวอร์ชันเบต้าพร้อมใช้งานแล้ว
API เวอร์ชัน 2 ขณะนี้อยู่ในช่วงเบต้าและพร้อมใช้งานแล้วบน pwpush.com และเวอร์ชัน Pro ที่ติดตั้งเอง API จะถูกเพิ่มเข้าไปในเวอร์ชันโอเพนซอร์สหลังจากที่ออกจากช่วงเบต้าแล้ว
สำหรับอินสแตนซ์ที่ติดตั้งเอง ให้ใช้โดเมนของคุณเอง URL พื้นฐานที่แสดงด้านบนสะท้อนถึงโฮสต์ปัจจุบันที่คุณกำลังเข้าถึง
GET /api/v2/version
ส่งคืนเวอร์ชัน API ปัจจุบัน รายละเอียดแอปพลิเคชัน และแฮชคุณสมบัติที่อธิบายว่าความสามารถใดบ้างที่เปิดใช้งานในอินสแตนซ์นี้
ตัวอย่างคำขอ
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 แบบไม่ระบุตัวตนหรือไม่
การตรวจสอบโทเค็น API - รองรับการตรวจสอบสิทธิ์ด้วยโทเค็น Bearer
ตัวสร้างรหัสผ่านเปิดใช้งาน - เปิดใช้งานการสร้างรหัสผ่าน วลีรหัสผ่าน และ PIN หรือไม่
ภาษาของตัวสร้างรหัสผ่าน - ภาษาที่รองรับสำหรับรายการคำศัพท์รหัสผ่าน
บัญชีเปิดใช้งาน - ตรวจสอบว่ารายการพื้นที่ทำงานมีอยู่ที่ /api/v2/workspaces หรือไม่ (เส้นทางเดิม /api/v2/accounts เป็นชื่อเรียกแทน)
เปิดใช้งานการผลักดัน - การสร้างและจัดการการแจ้งเตือนแบบพุชผ่าน API
พุช ส่งอีเมลอัตโนมัติ - ตรวจสอบว่าอินสแตนซ์นี้สามารถส่งลิงก์ลับทางอีเมลได้หรือไม่เมื่อสร้างอีเมล ฟังก์ชันนี้ใช้สำหรับการตรวจจับคุณสมบัติเท่านั้น — ใช้พารามิเตอร์ notify_recipients ในการสร้างอีเมลเพื่อยกเลิกการส่งอีเมลอัตโนมัติ ในขณะที่ยังคงระบุ notify_emails_to สำหรับผู้รับที่ได้รับการยืนยันตัวตน
เปิดใช้งานการผลักดันไฟล์แนบ - การแนบไฟล์ในการแจ้งเตือนแบบพุช
pushes.file_attachments.requires_authentication - ไฟล์แนบต้องมีการตรวจสอบสิทธิ์
คำขอเปิดใช้งาน - การสร้างและจัดการคำขอผ่าน API
คำขอส่งอีเมลอัตโนมัติ - ตรวจสอบว่าอินสแตนซ์นี้สามารถส่งลิงก์ลับทางอีเมลได้หรือไม่เมื่อสร้างอีเมล ฟังก์ชันนี้ใช้สำหรับการตรวจจับคุณสมบัติเท่านั้น — ใช้พารามิเตอร์ notify_recipients ในการสร้างอีเมลเพื่อยกเลิกการส่งอีเมลอัตโนมัติ ในขณะที่ยังคงระบุ notify_emails_to สำหรับผู้รับที่ได้รับการยืนยันตัวตน
คำขอแนบไฟล์เปิดใช้งานแล้ว - การแนบไฟล์ในคำตอบคำขอ
คำขอแนบไฟล์ต้องมีการตรวจสอบสิทธิ์ - ไฟล์แนบต้องมีการตรวจสอบสิทธิ์
POST /api/v2/generate
สร้างรหัสผ่าน วลีรหัสผ่าน หรือ PIN อย่างน้อยหนึ่งรายการ การตรวจสอบสิทธิ์เป็นทางเลือก คำขอที่ไม่ระบุตัวตนจะใช้นโยบายพื้นที่ทำงานหลัก (หรือนโยบายส่วนกลางที่โฮสต์เอง) ส่งโทเค็น Bearer เพื่อใช้นโยบายพื้นที่ทำงานที่ลงชื่อเข้าใช้ รวมถึงบนโดเมนที่กำหนดเอง
เมื่อนโยบายปิดใช้งานการกำหนดค่าเครื่องกำเนิดไฟฟ้า การตั้งค่าตัวเลือกเพิ่มเติมจะถูกละเลย และจะพิจารณาเฉพาะจำนวนนับเท่านั้น
หากปิดใช้งานการสร้างรหัสผ่าน API จะส่งคืนข้อความ 403 Forbidden
การสร้างคำขอถูกจำกัดไว้ที่ 30 คำขอต่อนาทีต่อที่อยู่ IP หรือผู้ใช้ที่ได้รับการยืนยันตัวตน
เนื้อหาคำขอ (JSON)
ส่งพารามิเตอร์ที่ส่วนรากของออบเจ็กต์ JSON ฟิลด์ที่ไม่ได้ระบุจะใช้ค่าเริ่มต้นตามนโยบายที่กำหนดไว้
| พารามิเตอร์ | ประเภท | คำอธิบาย |
|---|---|---|
workspace_id
ไม่จำเป็น
|
string | พื้นที่ทำงานที่ได้รับการยืนยันตัวตนเพื่อใช้กำหนดนโยบาย นอกจากนี้ยังรับค่า account_id ด้วย หากผู้เรียกไม่ใช่สมาชิกของพื้นที่ทำงานนั้น จะส่งคืนค่า 401 |
type
ไม่จำเป็น
|
string | รหัสผ่าน, วลีรหัสผ่าน หรือรหัส PIN |
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) หรือความยาวรหัส PIN (4–12) |
uppercase
ไม่จำเป็น
|
boolean | ควรใช้ตัวอักษรพิมพ์ใหญ่ในรหัสผ่าน |
lowercase
ไม่จำเป็น
|
boolean | ควรใช้ตัวอักษรพิมพ์เล็กในรหัสผ่าน |
digits
ไม่จำเป็น
|
boolean | ควรใส่ตัวเลขในรหัสผ่านด้วย |
symbols
ไม่จำเป็น
|
boolean | ใส่สัญลักษณ์ในรหัสผ่าน |
avoid_ambiguous
ไม่จำเป็น
|
boolean | ไม่รวมอักขระที่ไม่ชัดเจน เช่น 0, 0, 1 และ 1 |
min_digits
ไม่จำเป็น
|
integer | จำนวนหลักขั้นต่ำในรหัสผ่าน |
min_symbols
ไม่จำเป็น
|
integer | จำนวนสัญลักษณ์ขั้นต่ำในรหัสผ่าน |
charset
ไม่จำเป็น
|
string | ชุดตัวอักษรที่กำหนดไว้ล่วงหน้า: ASCII, ละติน, ซีริลลิก หรือกรีก ค่าอื่นๆ จะถือเป็นชุดตัวอักษรที่กำหนดเอง |
ช่องตอบกลับ
| สนาม | คำอธิบาย |
|---|---|
type |
รหัสผ่าน, วลีรหัสผ่าน หรือรหัส PIN |
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
}'
ตัวอย่าง: สร้างและเรียกข้อมูลแบบ Push
# 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"
}
}'
รัฐที่ร้องขอ
API นี้ใช้รหัสสถานะ HTTP มาตรฐาน:
200 OK
คำขอสำเร็จแล้ว
201 Created
สร้างทรัพยากร
400 Bad Request
พารามิเตอร์ไม่ถูกต้อง
422 Unprocessable Entity
ข้อผิดพลาดในการตรวจสอบความถูกต้องหรือข้อมูลคำขอไม่ถูกต้อง
401 Unauthorized
จำเป็นต้องยืนยันตัวตน
403 Forbidden
การเข้าถึงถูกปฏิเสธ
404 Not Found
ไม่พบทรัพยากร
การจำกัดอัตราการใช้งานถูกนำมาใช้เพื่อป้องกันการใช้ API ในทางที่ผิดและเพื่อให้มั่นใจว่าผู้ใช้ทุกคนสามารถใช้งานได้อย่างเป็นธรรม การจำกัดอัตราการใช้งานจะถูกนำไปใช้กับที่อยู่ IP แต่ละที่อยู่ และจะแตกต่างกันไปตามประเภทของคำขอและปลายทาง
การร้องขอ GET เพื่อขอตรวจสอบบันทึกการตรวจสอบถูกจำกัดไว้ที่ 15 ครั้งต่อนาทีต่อ IP โดยมีขีดจำกัดสูงสุดที่ 5 ครั้งต่อ 10 วินาที และ 30 ครั้งต่อนาทีต่อผู้ใช้ที่ได้รับการรับรองสิทธิ์หรือโทเค็น API
การตอบสนองที่จำกัดอัตรา
เมื่อจำนวนคำขอเกินขีดจำกัด API จะส่งคืนค่า 429 Too Many Requests รหัสสถานะที่มี Retry-After ส่วนหัวที่ระบุว่าคุณสามารถลองส่งคำขออีกครั้งได้เมื่อใด
ปฏิบัติที่ดีที่สุด
- ใช้การหน่วงเวลาแบบทวีคูณเมื่อได้รับข้อความตอบกลับ 429
- เคารพ
Retry-Afterค่าส่วนหัว - แคชการตอบสนองเมื่อเหมาะสมเพื่อลดจำนวนการเรียกใช้ API
- ควรดำเนินการแบบกลุ่มเมื่อเป็นไปได้ แทนที่จะส่งคำขอทีละรายการจำนวนมาก
- ตรวจสอบการใช้งาน API ของแอปพลิเคชันของคุณอย่างสม่ำเสมอเพื่อหลีกเลี่ยงการใช้งานเกินขีดจำกัด
บันทึก: การจำกัดอัตราการใช้งานถูกออกแบบมาเพื่อป้องกันการใช้งานในทางที่ผิด ในขณะที่ยังคงอนุญาตให้ใช้งานอย่างถูกต้องได้ หากคุณพบปัญหาการจำกัดอัตราการใช้งานอย่างต่อเนื่อง โปรดพิจารณาปรับปรุงการผสานรวมระบบของคุณ หรือติดต่อฝ่ายสนับสนุนเพื่อหารือเกี่ยวกับกรณีการใช้งานของคุณ
อัปเดตล่าสุด: November 15, 2026