Password Pusher API v2

БЕТА

Вичерпна документація REST API для інтеграції Password Pusher у ваші програми

Бета-версія: API v2 наразі знаходиться в бета-версії. Хоча ми доклали всіх зусиль для забезпечення стабільності, до фінального релізу можуть бути внесені суттєві зміни. Ми будемо раді вашим відгукам!

Робочі місця

Робочі області - це спосіб, за допомогою якого Password Pusher організовує запити для команд і окремих користувачів. Користувач може належати до кількох робочих просторів. Створюючи пуші або запити, націльте їх на певну робочу область, передавши workspace_id з ідентифікатором робочого простору.

Примітка: Цей параметр раніше мав назву account_id і перейменовано на workspace_id. Спадщина account_id ім'я все ще приймається для зворотної сумісності.

За замовчуванням у вас є один робочий простір. На pwpush.com ви можете створити додаткові робочі простори для вашої команди або організації. У Self-Hosted Pro для вас створюється лише один робочий простір.

Перелічіть робочі простори з 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"
  }
]

Поля для відповідей

Поле	Type	Опис
`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.