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!

Eskaerak

Eskaerek informazio sentikorra biltzeko komunikazio bidirekzional segurua ahalbidetzen dute. Sortu eskaera bat URL sekretu batekin, partekatu edonorekin eta jaso testua edo fitxategiak dituzten erantzun seguruak, guztia posta elektronikoan, txatean edo erregistroetan datu sentikorrak erakutsi gabe.

Ezin hobea kredentzialak, API gakoak, dokumentu konfidentzialak edo lankideen, bezeroen edo kontsumitzaileen edozein informazio sentikor biltzeko. Erantzunak automatikoki enkriptatzen dira eta automatikoki ezabatzen dira denbora jakin baten ondoren, datuen eraginpean egotea gutxitzeko. Bizitza-ziklo osoaren jarraipena eskaera bakoitzaren auditoria-erregistroetan dago eskuragarri.

Eskaerek hiru egoera dituzte:

open Eskaera sortu da eta erantzun baten zain dago. Partekatu eskaeraren URLa hartzailearekin.

ready Erantzun bat eman da eta berreskuratzeko moduan dago. Jatorrizko eskatzaileak erantzuna atzitu dezake orain.

closed Eskaera iraungi egin da edo eskuz itxi da. Datu sentikor guztiak behin betiko ezabatu dira.

POST /api/v2/requests

Eskaera berri bat sortzen du. Autentifikazioa behar du.

Request Body (JSON)

{
  "request": {
    "request": "Please provide your hosting information here.",
    "close_after_duration": 8,
    "passphrase": "optional_passphrase",
    "name": "Database Access Request",
    "note": "Internal note",
    "retrieval_step": true,
    "include_requestor": false,
    "response_file_attachments": true
  }
}

Request Body with Files (multipart/form-data)

curl -X POST https://us.pwpush.com/api/v2/requests \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "request[request]=Please provide your hosting information here." \
  -F "request[close_after_duration]=8" \
  -F "request[name]=Database Access Request" \
  -F "request[files][]=@/path/to/document.pdf" \
  -F "request[files][]=@/path/to/spreadsheet.xlsx"

Note: When attaching files, use multipart/form-data format. Multiple files can be attached using request[files][].

Parameters

Parameter	Type	Description
`request` derrigorrezkoa	string	Partekatzeko eskaeraren testua/mezua
`close_after_duration` aukerakoa	integer (0-17)	Iraupenaren zerrenda - eskaera noiz itxi behar den
`passphrase` aukerakoa	string	Eskatu hartzaileek pasahitz hau sartzea ikusteko
`name` aukerakoa	string	Izen bat aginte-panelean, jakinarazpenetan eta mezu elektronikoetan agertzen da
`note` aukerakoa	string	Barne oharra (sortzaileak bakarrik ikus dezake)
`retrieval_step` aukerakoa	boolean	Txat sistemek eta URL eskanerrek bistak jatea saihesten laguntzen du
`include_requestor` aukerakoa	boolean	Eskatzailearen informazioa eskaeran sartu
`response_file_attachments` aukerakoa	boolean	Onartu fitxategien eranskinak erantzunetan
`files` aukerakoa	array	Eskaerari igo eta erantsi beharreko fitxategia(k)
`notify_emails_to` aukerakoa	string	Eskaera bat sortzen denean jakinaraziko zaizkien helbide elektronikoak (komaz bereizita)
`notify_emails_to_locale` aukerakoa	string	Mezu elektroniko bidezko jakinarazpenak bidaltzeko hizkuntza
`authenticated_recipients` aukerakoa	boolean	Eskatu posta elektronikoaren OTP egiaztapena sartzeko. notify_emails_to behar da. Gaituta dagoenean arakatzailean bakarrik (API berreskuratze/erantzun 403 itzultzen du).
`account_id` aukerakoa	integer	Eskaera lotzeko kontuaren IDa

Iraupen-balioak `close_after_duration`

0: 15 minutu

1: 30 minutu

2: 45 minutu

3: 1 ordu

4: 6 ordu

5: 12 ordu

6: 1 egun

7: 2 egun

8: 3 egun

9: 4 egun

10: 5 egun

11: 6 egun

12: Astebete

13: 2 aste

14: 3 aste

15: hilabete 1

16: 2 hilabete

17: 3 hilabete

Eskaera adibidea

curl -X POST https://us.pwpush.com/api/v2/requests \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "request": {
      "request": "Please provide your hosting information here.",
      "close_after_duration": 8,
      "passphrase": "optional_passphrase",
      "name": "Database Access Request"
    }
  }'

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

uri = URI('https://us.pwpush.com/api/v2/requests')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri.path)
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request['Content-Type'] = 'application/json'
request.body = {
  request: {
    request: 'Please provide your hosting information here.',
    close_after_duration: 8,
    passphrase: 'optional_passphrase',
    name: 'Database Access Request'
  }
}.to_json

response = http.request(request)
puts response.body

import requests
import json

url = 'https://us.pwpush.com/api/v2/requests'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}
data = {
    'request': {
        'request': 'Please provide your hosting information here.',
        'close_after_duration': 8,
        'passphrase': 'optional_passphrase',
        'name': 'Database Access Request'
    }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

$headers = @{
    'Authorization' = 'Bearer YOUR_API_TOKEN'
    'Content-Type' = 'application/json'
}

$body = @{
    request = @{
        request = 'Please provide your hosting information here.'
        close_after_duration = 8
        passphrase = 'optional_passphrase'
        name = 'Database Access Request'
    }
} | ConvertTo-Json -Depth 10

$response = Invoke-RestMethod -Uri 'https://us.pwpush.com/api/v2/requests' `
    -Method Post `
    -Headers $headers `
    -Body $body

$response | ConvertTo-Json

GET /api/v2/requests/:url_token

Irekita edo prest dagoen eskaera baten edukia berreskuratzen du. Honek eskaera itxi dezake ikustaldi kopuru jakin baten ondoren ixteko konfiguratuta badago.

Eskaera adibidea

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a

Adibide eskaera pasahitz batekin

curl -X GET "https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a?passphrase=your_passphrase"

Erantzunaren adibidea (eskaera irekia)

{
  "close_after_duration": 8,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": true,
  "passphrase": "optional_passphrase",
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:00:00.000Z",
  "state": "open",
  "include_requestor": false,
  "response_file_attachments": true,
  "close_after_at": "2023-11-04T10:00:00.000Z",
  "days_remaining": 8,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "request": "Please provide your hosting information here.",
  "response": null,
  "files": []
}

Erantzunaren adibidea (eskaera prest)

{
  "close_after_duration": 8,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": true,
  "passphrase": "optional_passphrase",
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:00:00.000Z",
  "state": "ready",
  "include_requestor": false,
  "response_file_attachments": true,
  "close_after_at": "2023-11-04T10:00:00.000Z",
  "days_remaining": 8,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "request": null,
  "response": "The API key is: sk_live_1234567890",
  "files": []
}

Oharra: Eskaerak pasahitz bat badu, sartu kontsulta-parametro gisa: ?passphrase=your_passphrase. Eskaera bat berreskuratzeak ikustaldi gisa hartzen du kontuan eta eskaera itxi egin dezake ikustaldi mugara iristen bada.

PATCH /api/v2/requests/:url_token/respond

Eskaera ireki bati erantzuten dio, 'prest' egoerara aldatuz.

Request Body (JSON)

{
  "request": {
    "response": "The API key is: sk_live_1234567890"
  }
}

Request Body with Files (multipart/form-data)

curl -X PATCH https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "request[response]=The API key is: sk_live_1234567890" \
  -F "request[files][]=@/path/to/response_doc.pdf"

Note: When attaching files, use multipart/form-data format. Multiple files can be attached using request[files][].

Parametroak

Parametroa	Mota	Deskribapena
`response` derrigorrezkoa	string	Eskaeraren erantzun-testua/mezua
`files` aukerakoa	array	Erantzunari erantsi beharreko fitxategia(k) (beharrezkoa da) `response_file_attachments: true` eskaeraren arabera)

Oharra: "Irekita" egoeran dauden eskaerek bakarrik jaso ditzakete erantzunak. Erantzun bat bidali ondoren, eskaera "prest" egoerara pasatzen da eta ezin ditu erantzun gehiago onartu.

GET /api/v2/requests/:url_token/preview

Eskaera baten URL sekretu osoa itzultzen du edukia berreskuratu gabe.

Eskaera adibidea

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/preview

Adibide Erantzuna

{
  "url": "https://us.pwpush.com/r/orpw2wkg00vpn0a"
}

GET /api/v2/requests/:url_token/audit

Eskaera baten auditoria-erregistroa itzultzen du. Autentifikazioa eta jabetza behar ditu.

Kontsulta-parametroak:

page (aukerakoa): Orrialde-zenbakia orrialdekatze-punturako.

Lehenetsia: 1 (lehen orrialdea)
Barrutia: 1 ra 200
Orrialde bakoitzeko 50 auditoria-erregistro sarrera itzultzen ditu gehienez
Adibidea: ?page=2 bigarren orrialdea berreskuratzeko

Eskaera adibidea

curl -X GET https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/audit \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Adibide Erantzuna

{
  "logs": [
    {
      "ip": "192.168.1.100",
      "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36",
      "referrer": null,
      "kind": "creation",
      "created_at": "2023-10-27T10:00:00.000Z",
      "updated_at": "2023-10-27T10:00:00.000Z"
    },
    {
      "ip": "192.168.1.101",
      "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
      "referrer": "https://example.com",
      "kind": "view",
      "created_at": "2023-10-27T10:05:00.000Z",
      "updated_at": "2023-10-27T10:05:00.000Z"
    },
    {
      "ip": "192.168.1.102",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit/605.1.15",
      "referrer": null,
      "kind": "response",
      "created_at": "2023-10-27T10:10:00.000Z",
      "updated_at": "2023-10-27T10:10:00.000Z"
    }
  ]
}

Oharra: The kind eremuak erregistratutako ekintza mota adierazten du. Balio ohikoenak hauek dira: creation, view, response, close, failed_passphrase, eta failed_view.

DELETE /api/v2/requests/:url_token

Eskaera berehala ixten du eta harekin lotutako datu sentikor guztiak behin betiko ezabatzen ditu. Ekintza hau atzeraezina da eta ezin da desegin. Autentifikazioa eta jabetza behar ditu.

Eskaera adibidea

curl -X DELETE https://us.pwpush.com/api/v2/requests/orpw2wkg00vpn0a \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Adibide Erantzuna

{
  "close_after_duration": null,
  "url_token": "orpw2wkg00vpn0a",
  "retrieval_step": false,
  "passphrase": null,
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:15:00.000Z",
  "state": "closed",
  "include_requestor": false,
  "response_file_attachments": false,
  "close_after_at": null,
  "days_remaining": null,
  "json_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://us.pwpush.com/r/orpw2wkg00vpn0a",
  "account_id": 1,
  "note": null,
  "name": null,
  "request": null,
  "response": null,
  "files": []
}

GET /api/v2/requests/active

Zure eskaera aktiboen (irekita edo prest dauden) zerrenda orrialdekatua itzultzen du. Autentifikazioa behar du.

GET /api/v2/requests/open

Zure eskaeren orrialde-zerrenda itzultzen du. Autentifikazioa behar du.

GET /api/v2/requests/ready

Prest dauden eskaeren orrialde-zerrenda itzultzen du. Autentifikazioa behar du.

GET /api/v2/requests/closed

Itxitako eskaeren orrialde-zerrenda itzultzen du. Autentifikazioa behar du.

Kontsulta-parametroak:

page (aukerakoa): Orrialde-zenbakia orrialdekatze-punturako.

Lehenetsia: 1 (lehen orrialdea)
Barrutia: 1 ra 200
Orrialdeko 50 eskaera itzultzen ditu gehienez
Adibidea: ?page=2 bigarren orrialdea berreskuratzeko

Eskatutako estatuak

open

Ireki

Eskaera sortu da eta erantzun baten zain dago. Eskaeraren testua ikusgai dago, baina oraindik ez da erantzunik eman.

ready

Prest

Eskaerari erantzun zaio eta orain erantzunaren karga dauka. Eskaeraren testua ez da gehiago ikusten, baina erantzuna berreskuratzeko eskuragarri dago.

closed

Itxita

Eskaera kudeatu da eta datu sentikor guztiak (bai eskaera bai erantzuna) behin betiko ezabatu dira. Egoera hau itzulezina da.

Eskaera Adibidea (Aktibo)

curl -X GET https://us.pwpush.com/api/v2/requests/active \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Eskaera Adibidea (Irekia)

curl -X GET https://us.pwpush.com/api/v2/requests/open \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Eskaera Adibidea (Prest)

curl -X GET https://us.pwpush.com/api/v2/requests/ready \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Eskaera Adibidea (Itxita)

curl -X GET https://us.pwpush.com/api/v2/requests/closed \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Adibide Erantzuna

[
  {
    "close_after_duration": 7,
    "url_token": "abc123xyz789",
    "retrieval_step": false,
    "passphrase": null,
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z",
    "state": "open",
    "include_requestor": false,
    "response_file_attachments": false,
    "close_after_at": "2023-11-03T10:00:00.000Z",
    "days_remaining": 7,
    "json_url": "https://us.pwpush.com/r/abc123xyz789.json",
    "html_url": "https://us.pwpush.com/r/abc123xyz789",
    "account_id": 1,
    "note": null,
    "name": null
  },
  {
    "close_after_duration": 7,
    "url_token": "def456uvw012",
    "retrieval_step": false,
    "passphrase": null,
    "created_at": "2023-10-26T15:30:00.000Z",
    "updated_at": "2023-10-27T09:00:00.000Z",
    "state": "ready",
    "include_requestor": false,
    "response_file_attachments": false,
    "close_after_at": "2023-11-02T15:30:00.000Z",
    "days_remaining": 6,
    "json_url": "https://us.pwpush.com/r/def456uvw012.json",
    "html_url": "https://us.pwpush.com/r/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Oharra: The /active amaierako muturrak bietan eskaerak itzultzen ditu open eta ready estatuak. Erabili /open edo /ready amaiera-puntuak egoera espezifikoaren arabera iragazteko.

Azken eguneraketa: July 20, 2026

Password Pusher API 2. bertsioa

Eskaerak

Eskaerek hiru egoera dituzte:

Eskaera bat sortu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Iraupen-balioak `close_after_duration`

Eskaera adibidea

Eskaera bat berreskuratu

Eskaera adibidea

Adibide eskaera pasahitz batekin

Erantzunaren adibidea (eskaera irekia)

Erantzunaren adibidea (eskaera prest)

Eskaera bati erantzun

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametroak

Eskaera baten aurrebista

Eskaera adibidea

Adibide Erantzuna

Eskaera Auditoria Erregistroa Eskuratu

Eskaera adibidea

Adibide Erantzuna

Eskaera bat itxi

Eskaera adibidea

Adibide Erantzuna

Eskatu bildumak

Eskatutako estatuak

Eskaera Adibidea (Aktibo)

Eskaera Adibidea (Irekia)

Eskaera Adibidea (Prest)

Eskaera Adibidea (Itxita)

Adibide Erantzuna

Password Pusher API 2. bertsioa

Eskaerak

Eskaerek hiru egoera dituzte:

Eskaera bat sortu

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Iraupen-balioak close_after_duration

Eskaera adibidea

Eskaera bat berreskuratu

Eskaera adibidea

Adibide eskaera pasahitz batekin

Erantzunaren adibidea (eskaera irekia)

Erantzunaren adibidea (eskaera prest)

Eskaera bati erantzun

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parametroak

Eskaera baten aurrebista

Eskaera adibidea

Adibide Erantzuna

Eskaera Auditoria Erregistroa Eskuratu

Eskaera adibidea

Adibide Erantzuna

Eskaera bat itxi

Eskaera adibidea

Adibide Erantzuna

Eskatu bildumak

Eskatutako estatuak

Eskaera Adibidea (Aktibo)

Eskaera Adibidea (Irekia)

Eskaera Adibidea (Prest)

Eskaera Adibidea (Itxita)

Adibide Erantzuna

Iraupen-balioak `close_after_duration`