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"
  }
]

Поля ответа

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