Password Pusher API верзије 2

БЕТА

Свеобухватна 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"
  }
]

Поља за одговор

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