Password Pusher API v2

BEETA

Kattava REST API -dokumentaatio integrointia varten Password Pusher sovelluksiisi

Beta-ilmoitus: API v2 on tällä hetkellä beta-versiossa. Vaikka olemme pyrkineet kaikin tavoin varmistamaan vakauden, ennen lopullista julkaisua saattaa tulla rikkovia muutoksia. Otamme mielellämme vastaan palautetta!

Työtilat

Työtilat ovat Password Pusherin tapa organisoida työntöt ja pyynnöt tiimeille ja yksilöille. Käyttäjä voi kuulua useisiin työtiloihin. Kun luot työntökohteita tai pyyntöjä, voit kohdistaa ne tiettyyn työtilaan antamalla parametrin workspace_id parametri, jossa on työtilan tunnus.

Huomautus: Tämän parametrin nimi oli aiemmin account_id ja nimettiin uudelleen muotoon workspace_id. Perintö account_id nimi hyväksytään edelleen taaksepäin yhteensopivuuden vuoksi.

Oletusarvoisesti sinulla on yksi työtila. Voit luoda pwpush.com-sivustolla lisää työtiloja tiimiäsi tai organisaatiotasi varten. Self-Hosted Pro -palvelussa sinulle luodaan vain yksi työtila.

Luettelo työtiloista GET /api/v2/workspaces tai vastaava GET /api/v1/workspaces. API v1:ssä ja v2:ssa vanhat polut ovat seuraavat GET /api/v1/accounts ja GET /api/v2/accounts palauttaa saman JSON-tiedoston.

GET /api/v2/workspaces

Legacy alias: GET /api/v2/accounts (identtinen vastaus).

Palauttaa kaikki työtilat, joihin todennettu käyttäjä kuuluu. Käytä kunkin kohteen id kuten workspace_id kun luot työntökohteita tai pyyntöjä.

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä	Tyyppi	Kuvaus
`id`	integer	Työtilan numeerinen tunnus. Välitä tämä arvo muodossa `workspace_id` kun luot työntökohteita tai pyyntöjä.
`name`	string	Työtilan näyttönimi
`created_at`	string (ISO 8601)	Kun työtila luotiin
`updated_at`	string (ISO 8601)	Milloin työtila on viimeksi päivitetty

Työtilan kohdentaminen

Kun luot työntökohteita tai pyyntöjä, voit valinnaisesti siirtää workspace_id resurssin liittämiseksi tiettyyn työtilaan. Jos se jätetään pois, resurssi luodaan oletustyötilaan.

Huom: Tämän parametrin nimi oli aiemmin account_id ja nimettiin uudelleen muotoon workspace_id. Perintö account_id nimi hyväksytään edelleen taaksepäin yhteensopivuuden vuoksi, mutta uusien integraatioiden tulisi käyttää nimeä workspace_id.

Tärkeää: Voit käyttää vain sellaisia työtilan tunnuksia, joihin kuulut. Toisen työtilan id:n käyttäminen palauttaa 401 Unauthorized.