Password Pusher API 2. bertsioa

BETA

REST API dokumentazio osoa integratzeko Password Pusher zure aplikazioetan

Beta oharra: API v2 beta bertsioan dago oraingoz. Egonkortasuna bermatzeko ahalegin guztiak egin ditugun arren, baliteke azken bertsioa baino lehen aldaketa garrantzitsuak egotea. Zure iritzia eskertzen dugu!

Lan-eremuak

Lan-eremuak dira Password Pusher-ek talde eta norbanakoentzako push-ak eta eskaerak antolatzen dituen modua. Erabiltzaile bat hainbat lan-eremutakoa izan daiteke. Push-ak edo eskaerak sortzerakoan, lan-eremu zehatz bat bideratu helburu gisa, pasatuz... workspace_id parametroa lan-eremuaren IDarekin.

Oharra: Parametro hau lehenago izendatu zen account_id eta izena aldatu zaio workspace_idOndarea account_id izena oraindik onartzen da atzeranzko bateragarritasunagatik.

Berez, lan-eremu bakarra duzu. pwpush.com webgunean, lan-eremu gehigarriak sor ditzakezu zure taldearentzat edo erakundearentzat. Self-Hosted Pro-n, lan-eremu bakarra sortzen da zuretzat.

Zerrendatu lan-eremuak hauekin: GET /api/v2/workspaces edo baliokidea GET /api/v1/workspacesAPI v1 eta v2-n, bide zaharkituak GET /api/v1/accounts eta GET /api/v2/accounts JSON bera itzuli.

GET /api/v2/workspaces

Legatu-aliasa: GET /api/v2/accounts (erantzun berdina).

Autentifikatutako erabiltzaileari dagokion lan-eremu guztiak itzultzen ditu. Erabili elementu bakoitzaren id bezala workspace_id push-ak edo eskaerak sortzerakoan.

Eskaera adibidea

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

Adibide Erantzuna

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

Erantzun Eremuak

Zelaia	Mota	Deskribapena
`id`	integer	Lan-eremuaren zenbakizko IDa. Pasatu balio hau honela: `workspace_id` push-ak edo eskaerak sortzerakoan.
`name`	string	Lan-eremuaren bistaratzeko izena
`created_at`	string (ISO 8601)	Lan-eremua sortu zenean
`updated_at`	string (ISO 8601)	Lan-eremua azken aldiz eguneratu zenean

Lan-eremu bat helburu hartuta

Push edo eskaerak sortzerakoan, aukeran pasa ditzakezu workspace_id baliabidea lan-eremu espezifiko batekin lotzeko. Ezabatzen bada, baliabidea zure lehenetsitako lan-eremuan sortzen da.

Oharra: Parametro hau lehenago izendatu zen account_id eta izena aldatu zaio workspace_idOndarea account_id izena oraindik onartzen da atzeranzko bateragarritasunagatik, baina integrazio berriek erabili beharko lukete workspace_id.

Garrantzitsua: Zure jabetzako lan-eremuaren IDak bakarrik erabil ditzakezu. Beste lan-eremu baten IDa erabiltzeak itzultzen du 401 Unauthorized.