Password Pusher API fersiwn 2

BETA

Dogfennaeth gynhwysfawr REST API ar gyfer integreiddio Password Pusher i mewn i'ch cymwysiadau

Hysbysiad Beta: Mae API v2 ar hyn o bryd mewn beta. Er ein bod wedi gwneud pob ymdrech i sicrhau sefydlogrwydd, efallai y bydd newidiadau torfol cyn y datganiad terfynol. Rydym yn croesawu eich adborth!

Mannau gwaith

Mannau gwaith yw sut mae Password Pusher yn trefnu gwthiadau a cheisiadau ar gyfer timau ac unigolion. Gall defnyddiwr berthyn i sawl man gwaith. Wrth greu gwthiadau neu geisiadau, targedwch fan gwaith penodol trwy basio'r workspace_id paramedr gyda'r ID gweithle.

Nodyn: Enwyd y paramedr hwn yn flaenorol account_id ac wedi'i ailenwi i workspace_idYr etifeddiaeth account_id mae'r enw'n dal i gael ei dderbyn ar gyfer cydnawsedd ôl-ôl.

Yn ddiofyn, mae gennych un gweithle. Ar pwpush.com, gallwch greu mannau gwaith ychwanegol ar gyfer eich tîm neu sefydliad. Yn Self-Hosted Pro, dim ond un gweithle sy'n cael ei greu i chi.

Rhestru mannau gwaith gyda GET /api/v2/workspaces neu'r hyn sy'n cyfateb GET /api/v1/workspacesYn API v1 a v2, y llwybrau etifeddol GET /api/v1/accounts a GET /api/v2/accounts dychwelyd yr un JSON.

GET /api/v2/workspaces

Ffugenw etifeddol: GET /api/v2/accounts (ymateb union yr un fath).

Yn dychwelyd pob gweithle y mae'r defnyddiwr dilys yn perthyn iddo. Defnyddiwch bob eitem id fel workspace_id wrth greu gwthiadau neu geisiadau.

Cais Enghraifft

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

Ymateb Enghraifft

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

Meysydd Ymateb

Maes	Math	Disgrifiad
`id`	integer	ID rhifol y gweithle. Pasiwch y gwerth hwn fel `workspace_id` wrth greu gwthiadau neu geisiadau.
`name`	string	Enw arddangos y gweithle
`created_at`	string (ISO 8601)	Pryd y crëwyd y gweithle
`updated_at`	string (ISO 8601)	Pryd y diweddarwyd y gweithle ddiwethaf

Targedu gweithle

Wrth greu gwthiadau neu geisiadau, gallwch chi basio'n ddewisol workspace_id i gysylltu'r adnodd â gweithle penodol. Os caiff ei hepgor, caiff yr adnodd ei greu yn eich gweithle diofyn.

Nodyn: Enwyd y paramedr hwn o'r blaen account_id ac wedi'i ailenwi i workspace_idYr etifeddiaeth account_id mae'r enw'n dal i gael ei dderbyn ar gyfer cydnawsedd ôl-ôl, ond dylai integreiddiadau newydd ddefnyddio workspace_id.

Pwysig: Dim ond IDau gweithle rydych chi'n perthyn iddo y cewch chi eu defnyddio. Mae defnyddio ID gweithle arall yn dychwelyd 401 Unauthorized.