Password Pusher API เวอร์ชัน 2

เบต้า

เอกสารประกอบการใช้งาน REST API อย่างครบถ้วนสำหรับการบูรณาการ Password Pusher ในแอปพลิเคชันของคุณ

ประกาศสำหรับรุ่นเบต้า: API เวอร์ชัน 2 ขณะนี้อยู่ในช่วงเบต้า แม้ว่าเราจะพยายามอย่างเต็มที่เพื่อให้มั่นใจถึงความเสถียรแล้ว แต่ก็อาจมีการเปลี่ยนแปลงที่ส่งผลกระทบต่อการทำงานก่อนการเปิดตัวเวอร์ชันเต็ม เรายินดีรับฟังความคิดเห็นของคุณ!

พื้นที่ทำงาน

พื้นที่ทำงาน (Workspaces) คือวิธีการที่ Password Pusher ใช้ในการจัดการการแจ้งเตือนและการร้องขอสำหรับทีมและบุคคล ผู้ใช้สามารถเป็นสมาชิกของพื้นที่ทำงานได้หลายแห่ง เมื่อสร้างการแจ้งเตือนหรือการร้องขอ ให้กำหนดเป้าหมายไปยังพื้นที่ทำงานที่ต้องการโดยการระบุพื้นที่ทำงานที่ต้องการ workspace_id พารามิเตอร์ที่มีรหัสพื้นที่ทำงาน

หมายเหตุ: พารามิเตอร์นี้เคยมีชื่อเดิมว่า... account_id และเปลี่ยนชื่อเป็น workspace_idมรดก account_id ชื่อดังกล่าวยังคงใช้ได้เพื่อความเข้ากันได้กับเวอร์ชันเก่า

โดยปกติแล้ว คุณจะมีพื้นที่ทำงานหนึ่งแห่ง บน pwpush.com คุณสามารถสร้างพื้นที่ทำงานเพิ่มเติมสำหรับทีมหรือองค์กรของคุณได้ แต่ใน Self-Hosted Pro จะมีการสร้างพื้นที่ทำงานให้คุณเพียงหนึ่งแห่งเท่านั้น

แสดงรายการพื้นที่ทำงานที่มี GET /api/v2/workspaces หรือเทียบเท่า GET /api/v1/workspacesใน API เวอร์ชัน 1 และ 2 เส้นทางเดิม (legacy paths) GET /api/v1/accounts และ GET /api/v2/accounts ส่งคืน JSON เดิม

GET /api/v2/workspaces

ชื่อเรียกเดิม: GET /api/v2/accounts (คำตอบเหมือนกัน)

ส่งคืนพื้นที่ทำงานทั้งหมดที่ผู้ใช้ที่เข้าสู่ระบบเป็นสมาชิกอยู่ ใช้ข้อมูลของแต่ละรายการ id เช่น workspace_id เมื่อสร้างการพุชหรือคำขอ

ตัวอย่างคำขอ

curl -X GET https://us.pwpush.com/api/v2/workspaces \
  -H "Authorization: Bearer YOUR_API_TOKEN"

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://us.pwpush.com/api/v2/workspaces')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))

import requests
import json

url = 'https://us.pwpush.com/api/v2/workspaces'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=2))

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
}

$response = Invoke-RestMethod -Uri 'https://us.pwpush.com/api/v2/workspaces' `
    -Method Get `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

ตัวอย่างคำตอบ

[
  {
    "id": 1,
    "name": "My Personal Workspace",
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z"
  },
  {
    "id": 2,
    "name": "Acme Corporation",
    "created_at": "2023-10-20T08:00:00.000Z",
    "updated_at": "2023-10-20T08:00:00.000Z"
  }
]

ช่องตอบกลับ

สนาม	ประเภท	คำอธิบาย
`id`	integer	รหัสตัวเลขของพื้นที่ทำงาน ส่งค่านี้เป็น `workspace_id` เมื่อสร้างการพุชหรือคำขอ
`name`	string	ชื่อที่แสดงของพื้นที่ทำงาน
`created_at`	string (ISO 8601)	เมื่อสร้างพื้นที่ทำงานแล้ว
`updated_at`	string (ISO 8601)	เมื่อมีการอัปเดตพื้นที่ทำงานครั้งล่าสุด

การกำหนดเป้าหมายพื้นที่ทำงาน

เมื่อสร้างการส่งข้อมูลแบบพุชหรือคำขอ คุณสามารถส่งค่าเพิ่มเติมได้ (ถ้าต้องการ) workspace_id เพื่อเชื่อมโยงทรัพยากรกับพื้นที่ทำงานเฉพาะ หากไม่ระบุ ระบบจะสร้างทรัพยากรในพื้นที่ทำงานเริ่มต้นของคุณ

บันทึก: พารามิเตอร์นี้เคยถูกตั้งชื่อว่า... account_id และเปลี่ยนชื่อเป็น workspace_idมรดก account_id ชื่อดังกล่าวยังคงใช้ได้เพื่อความเข้ากันได้กับเวอร์ชันเก่า แต่การผสานรวมใหม่ควรใช้ชื่ออื่น workspace_id.

สำคัญ: คุณสามารถใช้ได้เฉพาะรหัสพื้นที่ทำงานที่คุณเป็นสมาชิกอยู่เท่านั้น การใช้รหัสพื้นที่ทำงานของผู้อื่นจะส่งคืนค่าผิดพลาด 401 Unauthorized.