Password Pusher API leagan 2
BÉITEDoiciméadacht chuimsitheach REST API le haghaidh comhtháthú Password Pusher isteach i do chuid feidhmchlár
Fógra Béite: Tá API v2 i mbéite faoi láthair. Cé gur dhéanaimid gach iarracht chun cobhsaíocht a chinntiú, d'fhéadfadh athruithe bristeacha a bheith ann roimh an scaoileadh deiridh. Cuirimid fáilte roimh d'aiseolas!
Brúigh
Cumasaíonn brúnna tarchur slán, aontreo sonraí íogaire chuig faighteoirí. Cruthaigh brú le URL rúnda ina bhfuil téacs, comhaid, cóid QR, nó URLanna, agus ansin roinn é le duine ar bith—gan sonraí íogaire a nochtadh i ríomhphost, i gcomhrá ná i logaí.
Foirfe le haghaidh ionduchtú fostaithe, dintiúir chuntais a sheoladh, doiciméid rúnda a tharchur, nó aon fhaisnéis íogair a roinnt. Téann brúnna in éag go huathoibríoch tar éis tréimhse shonraithe nó líon áirithe radharcanna, agus tá rianú iomlán saolré ar fáil i logaí iniúchta gach brú.
POST /api/v2/pushes
Cruthaíonn sé brú nua leis an ualach a cuireadh ar fáil.
Corp Iarratais (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
}
Corp Iarratais le Comhaid (ilchodach/foirm-shonraí)
curl -X POST https://us.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"
Nóta: Agus comhaid á gceangal agat, bain úsáid as multipart/form-data formáid agus socraigh kind: "file". Is féidir comhaid iolracha a cheangal ag baint úsáide as push[files][].
Paraiméadair
| Paraiméadar | Cineál | Cur síos |
|---|---|---|
payload
ag teastáil
|
string | An téacs rúnda le roinnt |
expire_after_duration
roghnach
|
integer (0-17) | Uimhir fad (0-17) |
expire_after_views
roghnach
|
integer (1-100) | Líon na radharcanna roimh dhul in éag |
passphrase
roghnach
|
string | Éiligh frása faire le féachaint air |
name
roghnach
|
string | Ainm don bhrú |
note
roghnach
|
string | Nóta inmheánach (le feiceáil ag an cruthaitheoir amháin) |
deletable_by_viewer
roghnach
|
boolean | Lig do lucht féachana an bhrú a scriosadh |
retrieval_step
roghnach
|
boolean | Céim bhreise ag teastáil le haghaidh aisghabhála |
kind
roghnach
|
string | Clóscríobh: "téacs", "comhad", "url", nó "qr" (is é "téacs" an rogha réamhshocraithe) |
notify_emails_to
roghnach
|
string | Seoltaí ríomhphoist le cur ar an eolas nuair a chruthaítear brú (scartha le camóga) |
notify_emails_to_locale
roghnach
|
string | Teanga áitiúil le fógra(í) ríomhphoist a sheoladh inti |
authenticated_recipients
roghnach
|
boolean | Éilítear fíorú OTP ríomhphoist roimh fhéachaint. Éilítear notify_emails_to. Ní féidir é a aisghabháil ach sa bhrabhsálaí nuair a bhíonn sé cumasaithe (tuairisceann aisghabháil API 403). |
account_id
roghnach
|
integer | An ID cuntais le nascadh leis an mbrú (d'úsáideoirí a bhfuil cuntais iolracha acu) |
Luachanna Fad le haghaidh expire_after_duration
Réimsí Freagartha
Cuirtear na réimsí seo a leanas ar ais sa fhreagra agus brú á chruthú. Tabhair faoi deara: NÍ chuirtear ualach oibre agus comhaid ar ais nuair a chruthaítear iad—níl siad ar fáil ach amháin nuair a aisghabhtar brú trí GET.
| Páirc | Cineál | Sampla | Cur síos |
|---|---|---|---|
| account_id | integer or null | 1 | Aitheantas cuntais úinéara |
| created_at | string | "2025-02-17T10:00:00.000Z" | Am cruthaithe ISO 8601 |
| days_remaining | integer | 1 | Imithe i léig Laethanta iomlána fágtha (0 nuair < 1 lá); is fearr expires_at / expires_in |
| deletable_by_viewer | boolean | true | An féidir leis an bhfaighteoir an bhrú a scriosadh |
| deleted | boolean | false | Cibé acu ar scriosadh an bhrú go sainráite |
| expire_after_days | integer | 1 | Imithe i léig Laethanta measta (díorthaithe ó fhad) |
| expire_after_duration | integer | 6 | Uimhir fad (0–17); féach an tábla thuas |
| expire_after_views | integer | 5 | Uasmhéid radharcanna roimh dhul in éag |
| expired | boolean | false | Cibé an bhfuil an bhrú imithe in éag |
| expired_on | string or null | null | ISO 8601 nuair a chuaigh an bhrú in éag; neamhní mura bhfuil sé in éag |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | Am ISO 8601 nuair a théann an bhrú in éag; nialas má tá sé imithe in éag |
| expires_in | number | 86400 | Soicindí go dtí an dáta éaga (0 má tá an dáta éaga) |
| html_url | string | "https://.../p/abc" | URL le hoscailt sa bhrabhsálaí brúigh isteach |
| json_url | string | "https://.../p/abc.json" | URL chun brú a aisghabháil mar JSON |
| name | string or null | "Database credentials" | Ainm roghnach don bhrú |
| note | string or null | null | Nóta príobháideach roghnach |
| notify_emails_to | string or null | null | Ríomhphoist le fógra a thabhairt dóibh nuair a chruthaítear iad (préimh amháin) |
| passphrase | string or null | null | I láthair ach amháin má tá frása faire ag an mbrú (luach i bhfolach) |
| retrieval_step | boolean | false | Cibé an bhfuil céim bhreise ag teastáil chun aisghabháil |
| updated_at | string | "2025-02-17T10:00:00.000Z" | Am nuashonraithe dheireanaigh ISO 8601 |
| url_token | string | "fkwjfvhall92" | Aitheantóir rúnda uathúil don bhrú |
| views_remaining | integer | 5 | Radharcanna fágtha roimh dhul in éag |
Freagra Samplach:
{
"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"
}
Iarratas Samplach
curl -X POST https://us.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://us.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://us.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://us.pwpush.com/api/v2/pushes' `
-Method Post `
-Headers $headers `
-Body $body
$response | ConvertTo-Json
GET /api/v2/pushes/:url_token
Aisghabhann sé ualach rúnda bhrú. Méadaíonn sé seo líon na radharcanna agus d’fhéadfadh sé go gcuirfeadh sé deireadh leis an mbrú.
Réimsí Freagartha
Cuirtear na réimsí seo a leanas ar ais agus brú á aisghabháil. Cuireann an críochphointe seo an t-ualach agus na comhaid nach bhfuil ar fáil ag críochphointí eile ar ais.
| Páirc | Cineál | Sampla | Cur síos |
|---|---|---|---|
| created_at | string | "2025-02-17T10:00:00.000Z" | Am cruthaithe ISO 8601 |
| days_remaining | integer | 1 | Imithe i léig Laethanta iomlána fágtha (0 nuair < 1 lá); is fearr expires_at / expires_in |
| deletable_by_viewer | boolean | true | An féidir leis an bhfaighteoir an bhrú a scriosadh |
| deleted | boolean | false | Cibé acu ar scriosadh an bhrú go sainráite |
| expire_after_days | integer | 1 | Imithe i léig Laethanta measta (díorthaithe ó fhad) |
| expire_after_duration | integer | 6 | Uimhir ré (0–17) |
| expire_after_views | integer | 5 | Uasmhéid radharcanna roimh dhul in éag |
| expired | boolean | false | Cibé an bhfuil an bhrú imithe in éag |
| expired_on | string or null | null | ISO 8601 nuair a chuaigh an bhrú in éag; neamhní mura bhfuil sé in éag |
| expires_at | string or null | "2025-02-18T10:00:00.000Z" | Am ISO 8601 nuair a théann an bhrú in éag; nialas má tá sé imithe in éag |
| expires_in | number | 86400 | Soicindí go dtí an dáta éaga (0 má tá an dáta éaga) |
| files | array | [{ filename, content_type, url }] | Meiteashonraí comhaid ceangailte le URLanna íoslódála |
| html_url | string | "https://.../p/abc" | URL le hoscailt sa bhrabhsálaí brúigh isteach |
| json_url | string | "https://.../p/abc.json" | URL chun brú a aisghabháil mar JSON |
| passphrase | string or null | null | I láthair ach amháin má tá frása faire ag an mbrú (luach i bhfolach) |
| payload | string or null | "secret123" | An t-ábhar rúnda; neamhní nuair a bheidh sé imithe in éag |
| retrieval_step | boolean | false | Cibé an bhfuil céim bhreise ag teastáil chun aisghabháil |
| updated_at | string | "2025-02-17T10:00:00.000Z" | Am nuashonraithe dheireanaigh ISO 8601 |
| url_token | string | "fkwjfvhall92" | Aitheantóir rúnda uathúil don bhrú |
| views_remaining | integer | 2 | Radharcanna fágtha roimh dhul in éag |
Iarratas Samplach
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92
Iarratas Samplach le Pasfrása
curl -X GET "https://us.pwpush.com/api/v2/pushes/fkwjfvhall92?passphrase=your_passphrase"
Freagra Samplach
{
"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://us.pwpush.com/p/fkwjfvhall92.json",
"html_url": "https://us.pwpush.com/p/fkwjfvhall92",
"payload": "MySecretPassword123",
"files": []
}
Nóta: Má tá frása faire ag an mbrú, cuir san áireamh é mar pharaiméadar fiosrúcháin: ?passphrase=your_passphrase. Meastar gur radharc é aisghabháil brú agus féadfaidh sé an brú a chur in éag má shroicheann sé a theorainn radhairc.
GET /api/v2/pushes/:url_token/preview
Tugann sé URL rúnda láncháilithe brú ar ais gan an t-ualach a aisghabháil.
Iarratas Samplach
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92/preview
Freagra Samplach
{
"url": "https://us.pwpush.com/p/fkwjfvhall92"
}
GET /api/v2/pushes/:url_token/audit
Seolann sé an log iniúchta ar ais le haghaidh brú. Éilíonn sé fíordheimhniú agus úinéireacht.
Paraiméadair Iarratais:
page (roghnach): Uimhir leathanaigh le haghaidh uimhriú leathanaigh.
- Réamhshocrú:
1(an chéad leathanach) - Raon:
1go200 - Tugann sé suas le 50 iontráil loga iniúchta ar ais in aghaidh an leathanaigh
- Sampla:
?page=2chun an dara leathanach a aisghabháil
Iarratas Samplach
curl -X GET https://us.pwpush.com/api/v2/pushes/fkwjfvhall92/audit \
-H "Authorization: Bearer YOUR_API_TOKEN"
Freagra Samplach
{
"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"
}
]
}
Nóta: An kind Léiríonn an réimse an cineál gníomhaíochta atá logáilte. Áirítear ar na luachanna coitianta: creation, view, expire, failed_passphrase, agus failed_view.
DELETE /api/v2/pushes/:url_token
Cuireann sé deireadh láithreach le brú agus scriosann sé go buan gach sonraí íogaire, lena n-áirítear an t-ualach agus aon chomhaid atá ceangailte. Ní féidir an gníomh seo a aisiompú agus ní féidir é a chealú. Éilíonn sé fíordheimhniú agus úinéireacht, nó ní mór don bhrú a bheith cruthaithe le deletable_by_viewer: true.
Iarratas Samplach
curl -X DELETE https://us.pwpush.com/api/v2/pushes/fkwjfvhall92 \
-H "Authorization: Bearer YOUR_API_TOKEN"
Freagra Samplach
{
"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://us.pwpush.com/p/fkwjfvhall92.json",
"html_url": "https://us.pwpush.com/p/fkwjfvhall92",
"account_id": 1,
"note": null,
"name": null
}
GET /api/v2/pushes/active
Tugann sé liosta leathanaigh de do bhrúnna gníomhacha (neamh-éagtha) ar ais. Éilíonn sé fíordheimhniú.
GET /api/v2/pushes/expired
Tugann sé liosta leathanaigh de do bhrúnna atá imithe in éag ar ais. Éilíonn sé fíordheimhniú.
Paraiméadair Iarratais:
page (roghnach): Uimhir leathanaigh le haghaidh uimhriú leathanaigh.
- Réamhshocrú:
1(an chéad leathanach) - Raon:
1go200 - Tuairisceáin suas le 50 brú in aghaidh an leathanaigh
- Sampla:
?page=2chun an dara leathanach a aisghabháil
Iarratas Samplach (Gníomhach)
curl -X GET https://us.pwpush.com/api/v2/pushes/active \
-H "Authorization: Bearer YOUR_API_TOKEN"
Iarratas Samplach (In éag)
curl -X GET https://us.pwpush.com/api/v2/pushes/expired \
-H "Authorization: Bearer YOUR_API_TOKEN"
Freagra Samplach
[
{
"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://us.pwpush.com/p/abc123xyz789.json",
"html_url": "https://us.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://us.pwpush.com/p/def456uvw012.json",
"html_url": "https://us.pwpush.com/p/def456uvw012",
"account_id": 1,
"note": null,
"name": null
}
]
Nuashonraithe go deireanach: July 20, 2026