Password Pusher API v2

BETA versija

Visaptveroša REST API dokumentācija integrēšanai Password Pusher savās lietojumprogrammās

Beta paziņojums: API v2 pašlaik ir beta versijā. Lai gan esam pielikuši visas pūles, lai nodrošinātu stabilitāti, pirms galīgās versijas iznākšanas var notikt izmaiņas. Mēs gaidām jūsu atsauksmes!

Darba vietas

Darbvietas ir veids, kā Password Pusher organizē komandu un atsevišķu personu pieprasījumus un pieprasījumus. Lietotājs var piederēt vairākām darbvietām. Veidojot pieprasījumus vai pieprasījumus, izvēlieties konkrētu darbvietu, norādot parametru workspace_id parametrs ar darba telpas id.

Piezīme: Šis parametrs iepriekš tika nosaukts par account_id un pārdēvēts par workspace_id. Mantojums account_id nosaukums joprojām tiek pieņemts atpakaļejošas savietojamības dēļ.

Pēc noklusējuma jums ir viena darbvieta. Vietnē pwpush.com varat izveidot papildu darba vietas savai komandai vai organizācijai. Self-Hosted Pro versijā jums tiek izveidota tikai viena darbvieta.

Saraksta darbvietas ar GET /api/v2/workspaces vai līdzvērtīgu GET /api/v1/workspaces. API v1 un v2 vecie ceļi GET /api/v1/accounts un GET /api/v2/accounts atgriež tādu pašu JSON.

GET /api/v2/workspaces

Mantojuma aizstājvārds: GET /api/v2/accounts (identiska atbilde).

Atgriež visas darbvietas, kurām pieder autentificētais lietotājs. Izmantojiet katra elementa id kā workspace_id veidojot pieprasījumus vai pieprasījumus.

Pieprasījuma piemērs

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

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

uri = URI('https://eu.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://eu.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://eu.pwpush.com/api/v2/workspaces' `
    -Method Get `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Atbildes piemērs

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

Atbildes lauki

Laukums	Tips	Apraksts
`id`	integer	Darba telpas skaitliskais identifikators. Nodod šo vērtību kā `workspace_id` veidojot pieprasījumus vai pieprasījumus.
`name`	string	Darba telpas nosaukums
`created_at`	string (ISO 8601)	Kad darba telpa tika izveidota
`updated_at`	string (ISO 8601)	Kad darbvieta pēdējo reizi atjaunināta

Darba telpas mērķauditorijas atlase

Veidojot grūdienus vai pieprasījumus, varat pēc izvēles nodot workspace_id lai saistītu resursu ar konkrētu darbvietu. Ja tas netiek norādīts, resurss tiek izveidots jūsu noklusējuma darbvietā.

Piezīme: Šis parametrs iepriekš tika nosaukts par account_id un pārdēvēts par workspace_id. Mantojums account_id nosaukums joprojām tiek pieņemts atpakaļejošas saderības dēļ, bet jaunām integrācijām būtu jāizmanto workspace_id.

Svarīgi: Varat izmantot tikai tos darba telpas identifikatorus, kas jums pieder. Izmantojot citas darbvietas id, tiek atgriezts 401 Unauthorized.