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!

Bidalketak

Push-ek datu sentikorrak hartzaileei modu seguru eta noranzko bakarrekoan transmititzeko aukera ematen dute. Sortu push bat testua, fitxategiak, QR kodeak edo URLak dituen URL sekretu batekin, eta gero partekatu edonorekin, guztia posta elektronikoan, txatean edo erregistroetan datu sentikorrak erakutsi gabe.

Langileen hasierako faserako, kontu-kredentzialak bidaltzeko, dokumentu konfidentzialak transmititzeko edo informazio sentikorra partekatzeko aproposa. Push-ak automatikoki iraungitzen dira iraupen edo ikustaldi kopuru jakin baten ondoren, eta bizi-ziklo osoaren jarraipena push bakoitzaren auditoria-erregistroetan dago eskuragarri.

POST /api/v2/pushes

Emandako kargarekin push berri bat sortzen du.

Eskaeraren gorputza (JSON)

{
  "push": {
    "payload": "secret_password_123",
    "expire_after_duration": 6,
    "expire_after_views": 5,
    "passphrase": "optional_passphrase",
    "name": "Database Credentials",
    "note": "Internal note",
    "deletable_by_viewer": true,
    "retrieval_step": true,
    "kind": "text"
  },
  "account_id": 123
}

Eskaeraren Gorputza Fitxategiekin (multipart/form-data)

curl -X POST https://eu.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -F "push[payload]=secret_password_123" \
  -F "push[expire_after_duration]=6" \
  -F "push[expire_after_views]=5" \
  -F "push[name]=Database Credentials" \
  -F "push[files][]=@/path/to/file1.pdf" \
  -F "push[files][]=@/path/to/file2.txt"

Oharra: Fitxategiak eransterakoan, erabili multipart/form-data formatu eta ezarri kind: "file". Hainbat fitxategi erantsi daitezke erabiliz push[files][].

Parametroak

Parametroa	Mota	Deskribapena
`payload` derrigorrezkoa	string	Partekatzeko testu sekretua
`expire_after_duration` aukerakoa	integer (0-17)	Iraupenaren enum-a (0-17)
`expire_after_views` aukerakoa	integer (1-100)	Iraungitze aurreko ikustaldi kopurua
`passphrase` aukerakoa	string	Beharrezkoa da pasahitz bat ikusteko
`name` aukerakoa	string	Bultzadaren izena.
`note` aukerakoa	string	Barne oharra (sortzaileak bakarrik ikus dezake)
`deletable_by_viewer` aukerakoa	boolean	Utzi ikusleei bultzada ezabatzen
`retrieval_step` aukerakoa	boolean	Berreskuratzeko urrats gehigarri bat behar da
`kind` aukerakoa	string	Mota: "testua", "fitxategia", "url" edo "qr" (lehenetsia "testua" da)
`notify_emails_to` aukerakoa	string	Push bat sortzen denean jakinarazpenak jasoko diren helbide elektronikoak (komaz bereizita)
`notify_emails_to_locale` aukerakoa	string	Mezu elektroniko bidezko jakinarazpenak bidaltzeko hizkuntza
`account_id` aukerakoa	integer	Push-a lotzeko kontuaren IDa (kontu anitz dituzten erabiltzaileentzat)

Iraupen-balioak `expire_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

Erantzun Eremuak

Push bat sortzean, eremu hauek itzultzen dira erantzunean. Oharra: karga eta fitxategiak EZ dira itzultzen sortzean; GET bidez push bat berreskuratzean bakarrik daude eskuragarri.

Zelaia	Mota	Adibidea	Deskribapena
account_id	integer or null	1	Jabearen kontuaren IDa
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 sorrera ordua
days_remaining	integer	1	Zaharkituta Egun osoak geratzen dira (0 egun 1 baino gutxiago denean); nahiago da expires_at / expires_in
deletable_by_viewer	boolean	true	Hartzaileak push-a ezaba dezakeen ala ez
deleted	boolean	false	Push-a esplizituki ezabatu den ala ez
expire_after_days	integer	1	Zaharkituta Gutxi gorabeherako egunak (iraupenetik eratorriak)
expire_after_duration	integer	6	Iraupenaren zenbaketa (0–17); ikus goiko taula
expire_after_views	integer	5	Iraungitze aurreko ikustaldi maximoak
expired	boolean	false	Bultzada iraungi den ala ez
expired_on	string or null	null	ISO 8601 bultzada iraungi zenean; nulua iraungi ez bada
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 bultzada iraungitzen den ordua; iraungi bada nulua
expires_in	number	86400	Iraungi arteko segundoak (0 iraungi bada)
html_url	string	"https://.../p/abc"	URLa arakatzailean push irekitzeko
json_url	string	"https://.../p/abc.json"	URLa JSON gisa push berreskuratzeko
name	string or null	"Database credentials"	Push-aren izen aukerakoa
note	string or null	null	Aukerako ohar pribatua
notify_emails_to	string or null	null	Sortzean jakinarazteko mezu elektronikoak (premium bakarrik)
passphrase	string or null	null	Push-ek pasahitz bat badu bakarrik agertuko da (balioa ezkutatuta)
retrieval_step	boolean	false	Berreskuratzeko urrats gehigarri bat behar den ala ez
updated_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 azken eguneratze ordua
url_token	string	"fkwjfvhall92"	Push-erako identifikatzaile sekretu bakarra
views_remaining	integer	5	Iraungitze aurretik geratzen diren ikustaldiak

Erantzunaren adibidea:

{
  "expire_after_duration": 6,
  "expire_after_views": 5,
  "expired": false,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": true,
  "retrieval_step": false,
  "expired_on": null,
  "passphrase": null,
  "created_at": "2025-02-17T10:00:00.000Z",
  "updated_at": "2025-02-17T10:00:00.000Z",
  "expire_after_days": 1,
  "views_remaining": 5,
  "deleted": false,
  "days_remaining": 1,
  "expires_at": "2025-02-18T10:00:00.000Z",
  "expires_in": 86400,
  "json_url": "https://example.com/p/fkwjfvhall92.json",
  "html_url": "https://example.com/p/fkwjfvhall92",
  "account_id": 1,
  "note": null,
  "name": "Database Credentials"
}

Eskaera adibidea

curl -X POST https://eu.pwpush.com/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "MySecretPassword123",
      "expire_after_duration": 6,
      "expire_after_views": 3
    }
  }'

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

uri = URI('https://eu.pwpush.com/api/v2/pushes')
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 = {
  push: {
    payload: 'MySecretPassword123',
    expire_after_duration: 6,
    expire_after_views: 3
  }
}.to_json

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

import requests
import json

url = 'https://eu.pwpush.com/api/v2/pushes'
headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
}
data = {
    'push': {
        'payload': 'MySecretPassword123',
        'expire_after_duration': 6,
        'expire_after_views': 3
    }
}

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

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

$body = @{
    push = @{
        payload = 'MySecretPassword123'
        expire_after_duration = 6
        expire_after_views = 3
    }
} | ConvertTo-Json -Depth 10

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

$response | ConvertTo-Json

GET /api/v2/pushes/:url_token

Push baten sekretuaren karga berreskuratzen du. Honek ikustaldi kopurua handitzen du eta push-a iraungi dezake.

Erantzun Eremuak

Push bat berreskuratzean eremu hauek itzultzen dira. Amaierako puntu honek beste amaiera-puntuetan eskuragarri ez dauden karga eta fitxategiak itzultzen ditu.

Zelaia	Mota	Adibidea	Deskribapena
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 sorrera ordua
days_remaining	integer	1	Zaharkituta Egun osoak geratzen dira (0 egun 1 baino gutxiago denean); nahiago da expires_at / expires_in
deletable_by_viewer	boolean	true	Hartzaileak push-a ezaba dezakeen ala ez
deleted	boolean	false	Push-a esplizituki ezabatu den ala ez
expire_after_days	integer	1	Zaharkituta Gutxi gorabeherako egunak (iraupenetik eratorriak)
expire_after_duration	integer	6	Iraupenaren enum-a (0–17)
expire_after_views	integer	5	Iraungitze aurreko ikustaldi maximoak
expired	boolean	false	Bultzada iraungi den ala ez
expired_on	string or null	null	ISO 8601 bultzada iraungi zenean; nulua iraungi ez bada
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 bultzada iraungitzen den ordua; iraungi bada nulua
expires_in	number	86400	Iraungi arteko segundoak (0 iraungi bada)
files	array	[{ filename, content_type, url }]	Erantsitako fitxategiaren metadatuak deskargatzeko URLekin
html_url	string	"https://.../p/abc"	URLa arakatzailean push irekitzeko
json_url	string	"https://.../p/abc.json"	URLa JSON gisa push berreskuratzeko
passphrase	string or null	null	Push-ek pasahitz bat badu bakarrik agertuko da (balioa ezkutatuta)
payload	string or null	"secret123"	Eduki sekretua; iraungitakoan nulua
retrieval_step	boolean	false	Berreskuratzeko urrats gehigarri bat behar den ala ez
updated_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 azken eguneratze ordua
url_token	string	"fkwjfvhall92"	Push-erako identifikatzaile sekretu bakarra
views_remaining	integer	2	Iraungitze aurretik geratzen diren ikustaldiak

Eskaera adibidea

curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92

Adibide eskaera pasahitz batekin

curl -X GET "https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"

Adibide Erantzuna

{
  "expire_after_duration": 6,
  "expire_after_views": 3,
  "expired": false,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": false,
  "retrieval_step": false,
  "expired_on": null,
  "passphrase": null,
  "created_at": "2025-02-17T10:00:00.000Z",
  "updated_at": "2025-02-17T10:00:00.000Z",
  "expire_after_days": 1,
  "views_remaining": 2,
  "deleted": false,
  "days_remaining": 1,
  "expires_at": "2025-02-18T10:00:00.000Z",
  "expires_in": 86400,
  "json_url": "https://eu.pwpush.com/p/fkwjfvhall92.json",
  "html_url": "https://eu.pwpush.com/p/fkwjfvhall92",
  "payload": "MySecretPassword123",
  "files": []
}

Oharra: Push-ak pasahitz bat badu, sartu kontsulta-parametro gisa: ?passphrase=your_passphrase. Push bat berreskuratzeak ikustaldi gisa hartzen du eta push-a iraungi egin daiteke ikustaldi mugara iristen bada.

GET /api/v2/pushes/:url_token/preview

Push baten URL sekretu osoa itzultzen du, karga berreskuratu gabe.

Eskaera adibidea

curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/preview

Adibide Erantzuna

{
  "url": "https://eu.pwpush.com/p/fkwjfvhall92"
}

GET /api/v2/pushes/:url_token/audit

Push baterako 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://eu.pwpush.com/api/v2/pushes/fkwjfvhall92/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"
    }
  ]
}

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

DELETE /api/v2/pushes/:url_token

Push bat berehala iraungitzen du eta datu sentikor guztiak behin betiko ezabatzen ditu, karga eta erantsitako fitxategiak barne. Ekintza hau itzulezina da eta ezin da desegin. Autentifikazioa eta jabetza behar ditu, edo push-a honekin sortu behar izan da deletable_by_viewer: true.

Eskaera adibidea

curl -X DELETE https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92 \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Adibide Erantzuna

{
  "expire_after_duration": 7,
  "expire_after_views": 5,
  "expired": true,
  "url_token": "fkwjfvhall92",
  "deletable_by_viewer": false,
  "retrieval_step": false,
  "expired_on": "2023-10-27T10:15:00.000Z",
  "passphrase": null,
  "created_at": "2023-10-27T10:00:00.000Z",
  "updated_at": "2023-10-27T10:15:00.000Z",
  "expire_after_days": 7,
  "days_remaining": 0,
  "expires_at": null,
  "expires_in": 0,
  "views_remaining": 0,
  "deleted": true,
  "json_url": "https://eu.pwpush.com/p/fkwjfvhall92.json",
  "html_url": "https://eu.pwpush.com/p/fkwjfvhall92",
  "account_id": 1,
  "note": null,
  "name": null
}

GET /api/v2/pushes/active

Zure push aktiboen (iraungi gabekoen) zerrenda orrialdekatua itzultzen du. Autentifikazioa behar du.

GET /api/v2/pushes/expired

Iraungitako push-en orrialde-zerrenda itzultzen du. Autentifikazioa behar du.

Kontsulta-parametroak:

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

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

Eskaera Adibidea (Aktibo)

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

Eskaera Adibidea (Iraungita)

curl -X GET https://eu.pwpush.com/api/v2/pushes/expired \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Adibide Erantzuna

[
  {
    "expire_after_duration": 7,
    "expire_after_views": 5,
    "expired": false,
    "url_token": "abc123xyz789",
    "deletable_by_viewer": false,
    "retrieval_step": false,
    "expired_on": null,
    "passphrase": null,
    "created_at": "2023-10-27T10:00:00.000Z",
    "updated_at": "2023-10-27T10:00:00.000Z",
    "expire_after_days": 7,
    "days_remaining": 7,
    "expires_at": "2023-10-29T10:00:00.000Z",
    "expires_in": 172800,
    "views_remaining": 5,
    "deleted": false,
    "json_url": "https://eu.pwpush.com/p/abc123xyz789.json",
    "html_url": "https://eu.pwpush.com/p/abc123xyz789",
    "account_id": 1,
    "note": null,
    "name": null
  },
  {
    "expire_after_duration": 1,
    "expire_after_views": 3,
    "expired": false,
    "url_token": "def456uvw012",
    "deletable_by_viewer": true,
    "retrieval_step": false,
    "expired_on": null,
    "passphrase": null,
    "created_at": "2023-10-26T15:30:00.000Z",
    "updated_at": "2023-10-26T15:30:00.000Z",
    "expire_after_days": 1,
    "days_remaining": 0,
    "expires_at": "2023-10-26T16:00:00.000Z",
    "expires_in": 1200,
    "views_remaining": 2,
    "deleted": false,
    "json_url": "https://eu.pwpush.com/p/def456uvw012.json",
    "html_url": "https://eu.pwpush.com/p/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Azken eguneraketa: July 12, 2026

Password Pusher API 2. bertsioa

Bidalketak

Sortu bultzada bat

Eskaeraren gorputza (JSON)

Eskaeraren Gorputza Fitxategiekin (multipart/form-data)

Parametroak

Iraupen-balioak `expire_after_duration`

Erantzun Eremuak

Eskaera adibidea

Berreskuratu bultzada bat

Erantzun Eremuak

Eskaera adibidea

Adibide eskaera pasahitz batekin

Adibide Erantzuna

Aurreikusi bultzada bat

Eskaera adibidea

Adibide Erantzuna

Eskuratu Push auditoria erregistroa

Eskaera adibidea

Adibide Erantzuna

Push bat iraungi

Eskaera adibidea

Adibide Erantzuna

Bultzatu bildumak

Eskaera Adibidea (Aktibo)

Eskaera Adibidea (Iraungita)

Adibide Erantzuna

Password Pusher API 2. bertsioa

Bidalketak

Sortu bultzada bat

Eskaeraren gorputza (JSON)

Eskaeraren Gorputza Fitxategiekin (multipart/form-data)

Parametroak

Iraupen-balioak expire_after_duration

Erantzun Eremuak

Eskaera adibidea

Berreskuratu bultzada bat

Erantzun Eremuak

Eskaera adibidea

Adibide eskaera pasahitz batekin

Adibide Erantzuna

Aurreikusi bultzada bat

Eskaera adibidea

Adibide Erantzuna

Eskuratu Push auditoria erregistroa

Eskaera adibidea

Adibide Erantzuna

Push bat iraungi

Eskaera adibidea

Adibide Erantzuna

Bultzatu bildumak

Eskaera Adibidea (Aktibo)

Eskaera Adibidea (Iraungita)

Adibide Erantzuna

Iraupen-balioak `expire_after_duration`