Password Pusher API v2

بیٹا

انضمام کے لیے جامع REST API دستاویزات Password Pusher آپ کی درخواستوں میں

بیٹا نوٹس: API v2 فی الحال بیٹا میں ہے۔ اگرچہ ہم نے استحکام کو یقینی بنانے کے لیے ہر ممکن کوشش کی ہے، لیکن حتمی ریلیز سے پہلے کچھ تبدیلیاں ہو سکتی ہیں۔ ہم آپ کے تاثرات کا خیرمقدم کرتے ہیں!

کام کی جگہیں۔

ورک اسپیسز یہ ہیں کہ کس طرح پاس ورڈ پشر ٹیموں اور افراد کے لیے پش اور درخواستوں کو منظم کرتا ہے۔ ایک صارف متعدد ورک اسپیس سے تعلق رکھ سکتا ہے۔ دھکے یا درخواستیں بناتے وقت، پاس کرکے ایک مخصوص ورک اسپیس کو نشانہ بنائیں workspace_id ورک اسپیس آئی ڈی کے ساتھ پیرامیٹر۔

نوٹ: اس پیرامیٹر کا نام پہلے رکھا گیا تھا۔ account_id اور نام تبدیل کر دیا workspace_id. میراث account_id نام اب بھی پسماندہ مطابقت کے لیے قبول کیا جاتا ہے۔

بطور ڈیفالٹ، آپ کے پاس ایک ورک اسپیس ہے۔ pwpush.com پر، آپ اپنی ٹیم یا تنظیم کے لیے اضافی ورک اسپیس بنا سکتے ہیں۔ سیلف ہوسٹڈ پرو میں، آپ کے لیے صرف ایک ورک اسپیس بنائی گئی ہے۔

کے ساتھ کام کی جگہوں کی فہرست بنائیں GET /api/v2/workspaces یا مساوی GET /api/v1/workspaces. API v1 اور v2 میں، میراثی راستے 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.