Password Pusher API útgáfa 2

BETA

Ítarleg skjölun um REST API fyrir samþættingu Password Pusher í forritin þín

Tilkynning um beta-próf: API útgáfa 2 er nú í beta-útgáfu. Þó að við höfum gert allt sem í okkar valdi stendur til að tryggja stöðugleika, gætu orðið einhverjar breytingar áður en lokaútgáfan kemur út. Við tökum vel á móti ábendingum þínum!

Þrýstir

Sendingar gera kleift að senda viðkvæmar upplýsingar á öruggan hátt til viðtakenda í einstefnu. Búðu til sendingu með leynilegri vefslóð sem inniheldur texta, skrár, QR kóða eða vefslóðir og deildu henni síðan með hverjum sem er – allt án þess að afhjúpa viðkvæmar upplýsingar í tölvupósti, spjalli eða skrám.

Tilvalið fyrir innleiðingu starfsmanna, sendingu aðgangsupplýsinga, flutning trúnaðargagna eða miðlun viðkvæmra upplýsinga. Tilkynningar renna sjálfkrafa út eftir tiltekinn tíma eða fjölda skoðana og hægt er að fylgjast með öllum líftíma þeirra í endurskoðunarskrám hverrar tilkynningar.

POST /api/v2/pushes

Býr til nýja sendingu með gefnu álagi.

Beiðnitexti (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
}

Beiðni um meginmál með skrám (marghluta/eyðublaðsgögn)

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"

Athugið: Þegar þú tengir við skrár skaltu nota multipart/form-data snið og stilling kind: "file". Hægt er að hengja við margar skrár með því að nota push[files][].

Params

Færibreyta	Tegund	Lýsing
`payload` krafist	string	Leynitextinn til að deila
`expire_after_duration` valfrjálst	integer (0-17)	Tímalengdartalning (0-17)
`expire_after_views` valfrjálst	integer (1-100)	Fjöldi áhorfa fyrir lok gildistíma
`passphrase` valfrjálst	string	Krefjast lykilorðs til að skoða
`name` valfrjálst	string	Nafn fyrir ýtuna
`note` valfrjálst	string	Innri athugasemd (aðeins sýnileg höfundi)
`deletable_by_viewer` valfrjálst	boolean	Leyfa áhorfendum að eyða tilkynningunni
`retrieval_step` valfrjálst	boolean	Þarfnast auka skrefs til að sækja
`kind` valfrjálst	string	Sláðu inn: „texti“, „skrá“, „slóð“ eða „qr“ (sjálfgefið er „texti“)
`notify_emails_to` valfrjálst	string	Netföng sem á að fá tilkynningu þegar tilkynning er búin til (aðskilin með kommu)
`notify_emails_to_locale` valfrjálst	string	Tungumál til að senda tölvupósttilkynningar á
`account_id` valfrjálst	integer	Reikningsauðkenni sem tengja á tilkynninguna við (fyrir notendur með marga reikninga)

Tímalengdargildi fyrir `expire_after_duration`

0: 15 mínútur

1: 30 mínútur

2: 45 mínútur

3: 1 klukkustund

4: 6 klukkustundir

5: 12 klukkustundir

6: 1 dag

7: 2 dagar

8: 3 dagar

9: 4 dagar

10: 5 dagar

11: 6 dagar

12: 1 viku

13: 2 vikur

14: 3 vikur

15: 1 mánuður

16: 2 mánuðir

17: 3 mánuðir

Svarsvið

Eftirfarandi reitir eru skilaðir í svarinu þegar sending er búin til. Athugið: gagnageymsla og skrár eru EKKI skilað við stofnun — þær eru aðeins tiltækar þegar sending er sótt með GET.

Akur	Tegund	Dæmi	Lýsing
account_id	integer or null	1	Auðkenni eigandareiknings
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 sköpunartími
days_remaining	integer	1	Úrelt Heilir dagar eftir (0 þegar < 1 dagur); kjósa expires_at / expires_in
deletable_by_viewer	boolean	true	Hvort viðtakandinn megi eyða tilkynningunni
deleted	boolean	false	Hvort tilkynningunni hafi verið eytt sérstaklega
expire_after_days	integer	1	Úrelt Áætlaðir dagar (frá lengd)
expire_after_duration	integer	6	Tímalengdartalning (0–17); sjá töflu að ofan
expire_after_views	integer	5	Hámarksáhorf fyrir lok
expired	boolean	false	Hvort tilkynningin sé útrunnin
expired_on	string or null	null	ISO 8601 þegar tilkynningin rann út; núll ef ekki útrunnin
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 tími þegar tilkynningin rennur út; núll ef útrunnin
expires_in	number	86400	Sekúndur þar til gildistími rennur út (0 ef gildistími rennur út)
html_url	string	"https://.../p/abc"	Vefslóð til að opna í vafranum
json_url	string	"https://.../p/abc.json"	Vefslóð til að sækja tilkynningu sem JSON
name	string or null	"Database credentials"	Valfrjálst nafn fyrir ýtingu
note	string or null	null	Valfrjáls einkamiði
notify_emails_to	string or null	null	Netföng sem á að tilkynna við stofnun (eingöngu fyrir úrvalsútgáfur)
passphrase	string or null	null	Aðeins til staðar ef slóð hefur lykilorð (gildi falið)
retrieval_step	boolean	false	Hvort auka skref sé nauðsynlegt til að sækja
updated_at	string	"2025-02-17T10:00:00.000Z"	Síðasta uppfærslutími ISO 8601
url_token	string	"fkwjfvhall92"	Einkvæmt leynilegt auðkenni fyrir sendinguna
views_remaining	integer	5	Skoðanir eftir fyrir lok

Dæmi um svar:

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

Dæmi um beiðni

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

Sækir leynilegt efni úr tilkynningu. Þetta eykur áhorfstöluna og gæti leitt til þess að tilkynningin verði felld úr gildi.

Svarsvið

Eftirfarandi reitir eru skilaðir þegar sending er sótt. Þessi endapunktur skilar gagnamagninu og skrám sem eru ekki tiltækar á öðrum endapunktum.

Akur	Tegund	Dæmi	Lýsing
created_at	string	"2025-02-17T10:00:00.000Z"	ISO 8601 sköpunartími
days_remaining	integer	1	Úrelt Heilir dagar eftir (0 þegar < 1 dagur); kjósa expires_at / expires_in
deletable_by_viewer	boolean	true	Hvort viðtakandinn megi eyða tilkynningunni
deleted	boolean	false	Hvort tilkynningunni hafi verið eytt sérstaklega
expire_after_days	integer	1	Úrelt Áætlaðir dagar (frá lengd)
expire_after_duration	integer	6	Tímalengdartalning (0–17)
expire_after_views	integer	5	Hámarksáhorf fyrir lok
expired	boolean	false	Hvort tilkynningin sé útrunnin
expired_on	string or null	null	ISO 8601 þegar tilkynningin rann út; núll ef ekki útrunnin
expires_at	string or null	"2025-02-18T10:00:00.000Z"	ISO 8601 tími þegar tilkynningin rennur út; núll ef útrunnin
expires_in	number	86400	Sekúndur þar til gildistími rennur út (0 ef gildistími rennur út)
files	array	[{ filename, content_type, url }]	Viðhengd skráarlýsigögn með niðurhalsvefslóðum
html_url	string	"https://.../p/abc"	Vefslóð til að opna í vafranum
json_url	string	"https://.../p/abc.json"	Vefslóð til að sækja tilkynningu sem JSON
passphrase	string or null	null	Aðeins til staðar ef slóð hefur lykilorð (gildi falið)
payload	string or null	"secret123"	Leynilegt efni; núll þegar það rennur út
retrieval_step	boolean	false	Hvort auka skref sé nauðsynlegt til að sækja
updated_at	string	"2025-02-17T10:00:00.000Z"	Síðasta uppfærslutími ISO 8601
url_token	string	"fkwjfvhall92"	Einkvæmt leynilegt auðkenni fyrir sendinguna
views_remaining	integer	2	Skoðanir eftir fyrir lok

Dæmi um beiðni

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

Dæmi um beiðni með lykilorði

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

Dæmi um svar

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

Athugið: Ef tilkynningin hefur lykilorð, þá skal setja það inn sem fyrirspurnarfæribreytu: ?passphrase=your_passphrase. Að sækja tilkynningu telst sem skoðun og gæti eyðilagt tilkynninguna ef hún nær skoðunarmörkum sínum.

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

Skilar fullgildri leynilegri vefslóð sendingar án þess að sækja gagnamagnið.

Dæmi um beiðni

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

Dæmi um svar

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

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

Skilar endurskoðunarskrá fyrir sendingu. Krefst auðkenningar og eignarhalds.

Fyrirspurnarbreytur:

page (valfrjálst): Síðunúmer fyrir blaðsíðutalningu.

Sjálfgefið: 1 (fyrsta síða)
Svið: 1 til 200
Skilar allt að 50 færslum í endurskoðunarskrá á hverri síðu
Dæmi: ?page=2 að sækja aðra síðuna

Dæmi um beiðni

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

Dæmi um svar

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

Athugið: Hinn kind Reiturinn gefur til kynna gerð aðgerðarinnar sem skráð er. Algeng gildi eru meðal annars: creation, view, expire, failed_passphrase, og failed_view.

DELETE /api/v2/pushes/:url_token

Lokar strax tilkynningu og eyðir varanlega öllum viðkvæmum gögnum, þar á meðal gagnamagninu og öllum viðhengdum skrám. Þessi aðgerð er óafturkræf og ekki er hægt að afturkalla hana. Krefst auðkenningar og eignarhalds, eða tilkynningin verður að hafa verið búin til með deletable_by_viewer: true.

Dæmi um beiðni

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

Dæmi um svar

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

Skilar síðuskiptum lista yfir virka (ekki útrunna) tilkynningar. Krefst auðkenningar.

GET /api/v2/pushes/expired

Skilar síðuskiptum lista yfir útrunnar tilkynningar. Krefst auðkenningar.

Fyrirspurnarbreytur:

page (valfrjálst): Síðunúmer fyrir blaðsíðutalningu.

Sjálfgefið: 1 (fyrsta síða)
Svið: 1 til 200
Skilar allt að 50 færslum á síðu
Dæmi: ?page=2 að sækja aðra síðuna

Dæmi um beiðni (virk)

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

Dæmi um beiðni (útrunnin)

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

Dæmi um svar

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

Síðast uppfært: July 12, 2026

Password Pusher API útgáfa 2

Þrýstir

Búa til ýtingu

Beiðnitexti (JSON)

Beiðni um meginmál með skrám (marghluta/eyðublaðsgögn)

Params

Tímalengdargildi fyrir `expire_after_duration`

Svarsvið

Dæmi um beiðni

Sækja ýtingu

Svarsvið

Dæmi um beiðni

Dæmi um beiðni með lykilorði

Dæmi um svar

Forskoða tilkynningu

Dæmi um beiðni

Dæmi um svar

Sækja endurskoðunarskrá fyrir ýtingu

Dæmi um beiðni

Dæmi um svar

Renna út tilkynningu

Dæmi um beiðni

Dæmi um svar

Ýta innheimtum

Dæmi um beiðni (virk)

Dæmi um beiðni (útrunnin)

Dæmi um svar

Password Pusher API útgáfa 2

Þrýstir

Búa til ýtingu

Beiðnitexti (JSON)

Beiðni um meginmál með skrám (marghluta/eyðublaðsgögn)

Params

Tímalengdargildi fyrir expire_after_duration

Svarsvið

Dæmi um beiðni

Sækja ýtingu

Svarsvið

Dæmi um beiðni

Dæmi um beiðni með lykilorði

Dæmi um svar

Forskoða tilkynningu

Dæmi um beiðni

Dæmi um svar

Sækja endurskoðunarskrá fyrir ýtingu

Dæmi um beiðni

Dæmi um svar

Renna út tilkynningu

Dæmi um beiðni

Dæmi um svar

Ýta innheimtum

Dæmi um beiðni (virk)

Dæmi um beiðni (útrunnin)

Dæmi um svar

Tímalengdargildi fyrir `expire_after_duration`