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!

Gwthiadau

Mae gwthiadau yn galluogi trosglwyddo data sensitif yn ddiogel, unffordd i dderbynwyr. Crëwch wthiad gydag URL cyfrinachol sy'n cynnwys testun, ffeiliau, codau QR, neu URLau, yna rhannwch ef ag unrhyw un—i gyd heb ddatgelu data sensitif mewn e-bost, sgwrs, na logiau.

Perffaith ar gyfer ymsefydlu gweithwyr, anfon manylion mewngofnodi cyfrif, trosglwyddo dogfennau cyfrinachol, neu rannu unrhyw wybodaeth sensitif. Mae gwthiadau'n dod i ben yn awtomatig ar ôl cyfnod penodol neu nifer o ymweliadau, ac mae olrhain cylch bywyd llawn ar gael yn logiau archwilio pob gwthiad.

POST /api/v2/pushes

Yn creu gwthiad newydd gyda'r llwyth tâl a ddarperir.

Corff y Cais (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
}

Corff y Cais gyda Ffeiliau (aml-ran/ffurflen-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"

Nodyn: Wrth atodi ffeiliau, defnyddiwch multipart/form-data fformatio a gosod kind: "file". Gellir atodi ffeiliau lluosog gan ddefnyddio push[files][].

Paramedrau

Paramedr	Math	Disgrifiad
`payload` angenrheidiol	string	Y testun cyfrinachol i'w rannu
`expire_after_duration` dewisol	integer (0-17)	Enum hyd (0-17)
`expire_after_views` dewisol	integer (1-100)	Nifer o ymweliadau cyn dod i ben
`passphrase` dewisol	string	Angen cyfrinair i weld
`name` dewisol	string	Enw ar gyfer y gwthiad
`note` dewisol	string	Nodyn mewnol (dim ond yn weladwy i'r crëwr)
`deletable_by_viewer` dewisol	boolean	Caniatáu i wylwyr ddileu'r gwthiad
`retrieval_step` dewisol	boolean	Angen cam ychwanegol i adfer
`kind` dewisol	string	Teipiwch: "testun", "ffail", "url", neu "qr" (yn ddiofyn i "testun")
`notify_emails_to` dewisol	string	Cyfeiriadau e-bost i gael gwybod pan fydd gwthiad yn cael ei greu (wedi'u gwahanu gan goma)
`notify_emails_to_locale` dewisol	string	Lleoliad (iaith) i anfon hysbysiad(au) e-bost ynddo
`account_id` dewisol	integer	ID y cyfrif i gysylltu'r gwthiad ag ef (ar gyfer defnyddwyr sydd â chyfrifon lluosog)

Gwerthoedd Hyd ar gyfer `expire_after_duration`

0: 15 munud

1: 30 munud

2: 45 munud

3: 1 awr

4: 6 awr

5: 12 awr

6: 1 diwrnod

7: 2 ddiwrnod

8: 3 diwrnod

9: 4 diwrnod

10: 5 diwrnod

11: 6 diwrnod

12: 1 wythnos

13: 2 wythnos

14: 3 wythnos

15: 1 mis

16: 2 fis

17: 3 mis

Meysydd Ymateb

Mae'r meysydd canlynol yn cael eu dychwelyd yn yr ymateb wrth greu gwthiad. Nodyn: NID yw llwyth tâl a ffeiliau yn cael eu dychwelyd wrth greu—dim ond wrth adfer gwthiad trwy GET y maent ar gael.

Maes	Math	Enghraifft	Disgrifiad
account_id	integer or null	1	ID cyfrif y perchennog
created_at	string	"2025-02-17T10:00:00.000Z"	Amser creu ISO 8601
days_remaining	integer	1	Wedi'i ddirymu Dyddiau cyfan ar ôl (0 pan fydd < 1 diwrnod); yn well ganddo expires_at / expires_in
deletable_by_viewer	boolean	true	A all y derbynnydd ddileu'r gwthiad
deleted	boolean	false	A gafodd y gwthiad ei ddileu'n benodol
expire_after_days	integer	1	Wedi'i ddirymu Dyddiau bras (yn deillio o hyd)
expire_after_duration	integer	6	Enum hyd (0–17); gweler y tabl uchod
expire_after_views	integer	5	Uchafswm o ymweliadau cyn dod i ben
expired	boolean	false	P'un a yw'r gwthiad wedi dod i ben
expired_on	string or null	null	ISO 8601 pan ddaeth y gwthiad i ben; null os nad yw wedi dod i ben
expires_at	string or null	"2025-02-18T10:00:00.000Z"	Amser ISO 8601 pan fydd y gwthiad yn dod i ben; null os yw wedi dod i ben
expires_in	number	86400	Eiliadau tan ddiwedd y dyddiad (0 os yw wedi dod i ben)
html_url	string	"https://.../p/abc"	URL i agor porwr gwthio i mewn
json_url	string	"https://.../p/abc.json"	URL i nôl gwthio fel JSON
name	string or null	"Database credentials"	Enw dewisol ar gyfer y gwthiad
note	string or null	null	Nodyn preifat dewisol
notify_emails_to	string or null	null	E-byst i'w hysbysu wrth greu (premiwm yn unig)
passphrase	string or null	null	Dim ond os oes gan y gwthio gyfrinair (gwerth wedi'i guddio)
retrieval_step	boolean	false	A oes angen cam ychwanegol i adfer
updated_at	string	"2025-02-17T10:00:00.000Z"	Amser diweddariad diwethaf ISO 8601
url_token	string	"fkwjfvhall92"	Dynodwr cyfrinachol unigryw ar gyfer y gwthiad
views_remaining	integer	5	Golygfeydd a adawyd cyn dod i ben

Ymateb Enghraifft:

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

Cais Enghraifft

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

Yn nôl llwyth cyfrinachol gwthiad. Mae hyn yn cynyddu'r nifer o ymweliadau a gall ddod â'r gwthiad i ben.

Meysydd Ymateb

Dychwelir y meysydd canlynol wrth adfer gwthiad. Mae'r pwynt terfyn hwn yn dychwelyd y llwyth tâl a ffeiliau nad ydynt ar gael ar bwyntiau terfyn eraill.

Maes	Math	Enghraifft	Disgrifiad
created_at	string	"2025-02-17T10:00:00.000Z"	Amser creu ISO 8601
days_remaining	integer	1	Wedi'i ddirymu Dyddiau cyfan ar ôl (0 pan fydd < 1 diwrnod); yn well ganddo expires_at / expires_in
deletable_by_viewer	boolean	true	A all y derbynnydd ddileu'r gwthiad
deleted	boolean	false	A gafodd y gwthiad ei ddileu'n benodol
expire_after_days	integer	1	Wedi'i ddirymu Dyddiau bras (yn deillio o hyd)
expire_after_duration	integer	6	Enum hyd (0–17)
expire_after_views	integer	5	Uchafswm o ymweliadau cyn dod i ben
expired	boolean	false	P'un a yw'r gwthiad wedi dod i ben
expired_on	string or null	null	ISO 8601 pan ddaeth y gwthiad i ben; null os nad yw wedi dod i ben
expires_at	string or null	"2025-02-18T10:00:00.000Z"	Amser ISO 8601 pan fydd y gwthiad yn dod i ben; null os yw wedi dod i ben
expires_in	number	86400	Eiliadau tan ddiwedd y dyddiad (0 os yw wedi dod i ben)
files	array	[{ filename, content_type, url }]	Metadata ffeil ynghlwm gydag URLau lawrlwytho
html_url	string	"https://.../p/abc"	URL i agor porwr gwthio i mewn
json_url	string	"https://.../p/abc.json"	URL i nôl gwthio fel JSON
passphrase	string or null	null	Dim ond os oes gan y gwthio gyfrinair (gwerth wedi'i guddio)
payload	string or null	"secret123"	Y cynnwys cyfrinachol; null pan fydd wedi dod i ben
retrieval_step	boolean	false	A oes angen cam ychwanegol i adfer
updated_at	string	"2025-02-17T10:00:00.000Z"	Amser diweddariad diwethaf ISO 8601
url_token	string	"fkwjfvhall92"	Dynodwr cyfrinachol unigryw ar gyfer y gwthiad
views_remaining	integer	2	Golygfeydd a adawyd cyn dod i ben

Cais Enghraifft

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

Cais Enghraifft gyda Chyfrinair

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

Ymateb Enghraifft

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

Nodyn: Os oes gan y gwthiad gyfrinair, cynhwyswch ef fel paramedr ymholiad: ?passphrase=your_passphrase. Mae adfer gwthiad yn cyfrif fel golygfa a gall ddod â'r gwthiad i ben os yw'n cyrraedd ei derfyn golygfeydd.

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

Yn dychwelyd URL cyfrinachol cwbl gymwysedig gwthiad heb adfer y llwyth tâl.

Cais Enghraifft

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

Ymateb Enghraifft

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

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

Yn dychwelyd y log archwilio ar gyfer gwthio. Mae angen dilysu a pherchnogaeth.

Paramedrau'r Ymholiad:

page (dewisol): Rhif tudalen ar gyfer tudalennau.

Diofyn: 1 (tudalen gyntaf)
Ystod: 1 i 200
Yn dychwelyd hyd at 50 o gofnodion log archwilio fesul tudalen
Enghraifft: ?page=2 i adfer yr ail dudalen

Cais Enghraifft

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

Ymateb Enghraifft

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

Nodyn: Y kind Mae'r maes yn nodi'r math o weithred a gofnodwyd. Mae gwerthoedd cyffredin yn cynnwys: creation, view, expire, failed_passphrase, a failed_view.

DELETE /api/v2/pushes/:url_token

Yn dod â gwthiad i ben ar unwaith ac yn dileu'n barhaol yr holl ddata sensitif, gan gynnwys y llwyth tâl ac unrhyw ffeiliau sydd ynghlwm. Mae'r weithred hon yn anghildroadwy ac ni ellir ei dadwneud. Mae angen dilysu a pherchnogaeth, neu rhaid bod y gwthiad wedi'i greu gyda deletable_by_viewer: true.

Cais Enghraifft

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

Ymateb Enghraifft

{
  "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

Yn dychwelyd rhestr dudalennau o'ch gwthiadau gweithredol (heb ddod i ben). Angen dilysu.

GET /api/v2/pushes/expired

Yn dychwelyd rhestr dudalennau o'ch gwthiadau sydd wedi dod i ben. Angen dilysu.

Paramedrau'r Ymholiad:

page (dewisol): Rhif tudalen ar gyfer tudalennau.

Diofyn: 1 (tudalen gyntaf)
Ystod: 1 i 200
Yn dychwelyd hyd at 50 gwthiad fesul tudalen
Enghraifft: ?page=2 i adfer yr ail dudalen

Cais Enghraifft (Gweithredol)

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

Cais Enghraifft (Wedi Dod i Ben)

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

Ymateb Enghraifft

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

Diweddarwyd ddiwethaf: July 12, 2026

Password Pusher API fersiwn 2

Gwthiadau

Creu Gwthiad

Corff y Cais (JSON)

Corff y Cais gyda Ffeiliau (aml-ran/ffurflen-data)

Paramedrau

Gwerthoedd Hyd ar gyfer `expire_after_duration`

Meysydd Ymateb

Cais Enghraifft

Adfer Gwthiad

Meysydd Ymateb

Cais Enghraifft

Cais Enghraifft gyda Chyfrinair

Ymateb Enghraifft

Rhagolwg Gwthio

Cais Enghraifft

Ymateb Enghraifft

Cael Log Archwilio Gwthio

Cais Enghraifft

Ymateb Enghraifft

Dod i Ben Gwthiad

Cais Enghraifft

Ymateb Enghraifft

Casgliadau Gwthio

Cais Enghraifft (Gweithredol)

Cais Enghraifft (Wedi Dod i Ben)

Ymateb Enghraifft

Password Pusher API fersiwn 2

Gwthiadau

Creu Gwthiad

Corff y Cais (JSON)

Corff y Cais gyda Ffeiliau (aml-ran/ffurflen-data)

Paramedrau

Gwerthoedd Hyd ar gyfer expire_after_duration

Meysydd Ymateb

Cais Enghraifft

Adfer Gwthiad

Meysydd Ymateb

Cais Enghraifft

Cais Enghraifft gyda Chyfrinair

Ymateb Enghraifft

Rhagolwg Gwthio

Cais Enghraifft

Ymateb Enghraifft

Cael Log Archwilio Gwthio

Cais Enghraifft

Ymateb Enghraifft

Dod i Ben Gwthiad

Cais Enghraifft

Ymateb Enghraifft

Casgliadau Gwthio

Cais Enghraifft (Gweithredol)

Cais Enghraifft (Wedi Dod i Ben)

Ymateb Enghraifft

Gwerthoedd Hyd ar gyfer `expire_after_duration`