Password Pusher API útgáfa 2

BETA

Ítarleg skjölun um REST API fyrir samþættingu Password Pusher í forritin þín

Tilkynning um beta-próf: API útgáfa 2 er nú í beta-útgáfu. Þó að við höfum gert allt sem í okkar valdi stendur til að tryggja stöðugleika, gætu orðið einhverjar breytingar áður en lokaútgáfan kemur út. Við tökum vel á móti ábendingum þínum!

Vinnusvæði

Vinnusvæði eru hvernig Password Pusher skipuleggur beiðnir og tilkynningar fyrir teymi og einstaklinga. Notandi getur tilheyrt mörgum vinnusvæðum. Þegar beiðnir eða tilkynningar eru búnar til skal miða á ákveðið vinnusvæði með því að senda... workspace_id breyta með vinnusvæðisauðkenni.

Athugið: Þessi breyta var áður nefnd account_id og endurnefnt í workspace_idArfleifðin account_id Nafnið er enn viðurkennt vegna afturvirkrar samhæfni.

Sjálfgefið er að þú hafir eitt vinnusvæði. Á pwpush.com geturðu búið til fleiri vinnusvæði fyrir teymið þitt eða fyrirtækið. Í Self-Hosted Pro er aðeins eitt vinnusvæði búið til fyrir þig.

Listi yfir vinnusvæði með GET /api/v2/workspaces eða samsvarandi GET /api/v1/workspacesÍ API v1 og v2 eru eldri slóðirnar GET /api/v1/accounts og GET /api/v2/accounts skila sama JSON.

GET /api/v2/workspaces

Eldri dulnefni: GET /api/v2/accounts (eins svar).

Skilar öllum vinnusvæðum sem auðkenndur notandi tilheyrir. Notið gildi hvers hlutar. id eins og workspace_id þegar verið er að búa til tilkynningar eða beiðnir.

Dæmi um beiðni

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

Dæmi um svar

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

Svarsvið

Akur	Tegund	Lýsing
`id`	integer	Tölulegt auðkenni vinnusvæðisins. Sendið þetta gildi sem `workspace_id` þegar verið er að búa til tilkynningar eða beiðnir.
`name`	string	Sýningarheiti vinnusvæðisins
`created_at`	string (ISO 8601)	Þegar vinnusvæðið var búið til
`updated_at`	string (ISO 8601)	Hvenær vinnusvæðið var síðast uppfært

Að miða á vinnusvæði

Þegar þú býrð til tilkynningar eða beiðnir geturðu valfrjálst sent inn workspace_id til að tengja auðlindina við ákveðið vinnusvæði. Ef þessu er sleppt er auðlindin búin til í sjálfgefnu vinnusvæði þínu.

Athugið: Þessi breyta var áður nefnd account_id og endurnefnt í workspace_idArfleifðin account_id Nafnið er enn samþykkt vegna afturvirkrar samhæfni, en nýjar samþættingar ættu að nota workspace_id.

Mikilvægt: Þú mátt aðeins nota auðkenni vinnusvæðis sem þú tilheyrir. Að nota auðkenni annars vinnusvæðis skilar 401 Unauthorized.