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!

Beiðnir

Beiðnir gera kleift að nota örugga, tvíhliða samskipti til að safna viðkvæmum upplýsingum. Búðu til beiðni með leynilegri vefslóð, deildu henni með hverjum sem er og fáðu örugg svör sem innihalda texta eða skrár — allt án þess að afhjúpa viðkvæmar upplýsingar í tölvupósti, spjalli eða skrám.

Tilvalið til að safna innskráningarupplýsingum, API-lyklum, trúnaðarskjölum eða viðkvæmum upplýsingum frá samstarfsmönnum, viðskiptavinum eða viðskiptavinum. Svör eru sjálfkrafa dulkóðuð og eytt sjálfkrafa eftir tiltekinn tíma til að lágmarka gagnavernd. Ítarleg eftirlit með líftíma er aðgengilegt í endurskoðunarskrám hverrar beiðni.

Beiðnir hafa þrjár stöður:

open Beiðnin hefur verið búin til og bíður eftir svari. Deildu slóð beiðninnar með viðtakandanum.

ready Svar hefur borist og er tiltækt til afhendingar. Upprunalega beiðandinn hefur nú aðgang að svarinu.

closed Beiðnin er útrunnin eða henni hefur verið lokað handvirkt. Öllum viðkvæmum gögnum hefur verið eytt fyrir fullt og allt.

POST /api/v2/requests

Býr til nýja beiðni. Krefst auðkenningar.

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://eu.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` krafist	string	Beiðni um að deila textaskilaboðum/skilaboðum
`close_after_duration` valfrjálst	integer (0-17)	Tímalengdarupptalning - hvenær á að loka beiðninni
`passphrase` valfrjálst	string	Krefjast þess að viðtakendur slái inn þetta lykilorð til að skoða
`name` valfrjálst	string	Nafn sem birtist á mælaborðinu, í tilkynningum og tölvupósti
`note` valfrjálst	string	Innri athugasemd (aðeins sýnileg höfundi)
`retrieval_step` valfrjálst	boolean	Hjálpar til við að koma í veg fyrir að spjallkerfi og vefslóðaskannarar éti upp áhorf
`include_requestor` valfrjálst	boolean	Hafa upplýsingar um beiðanda með í beiðninni
`response_file_attachments` valfrjálst	boolean	Leyfa viðhengi í svörum
`files` valfrjálst	array	Skrá(r) til að hlaða upp og hengja við beiðnina
`notify_emails_to` valfrjálst	string	Netföng sem á að fá tilkynningu þegar beiðni 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 á að tengja beiðnina við

Tímalengdargildi fyrir `close_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

Dæmi um beiðni

curl -X POST https://eu.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://eu.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://eu.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://eu.pwpush.com/api/v2/requests' `
    -Method Post `
    -Headers $headers `
    -Body $body

$response | ConvertTo-Json

GET /api/v2/requests/:url_token

Sækir efni opins eða tilbúins beiðni. Þetta gæti lokað beiðninni ef hún er stillt á að lokast eftir ákveðinn fjölda skoðana.

Dæmi um beiðni

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

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

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

Dæmi um svar (opin beiðni)

{
  "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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "request": "Please provide your hosting information here.",
  "response": null,
  "files": []
}

Dæmi um svar (tilbúin beiðni)

{
  "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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "request": null,
  "response": "The API key is: sk_live_1234567890",
  "files": []
}

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

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

Svarar opinni beiðni og breytir stöðu hennar í „tilbúið“.

Request Body (JSON)

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

Request Body with Files (multipart/form-data)

curl -X PATCH https://eu.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][].

Params

Færibreyta	Tegund	Lýsing
`response` krafist	string	Svarskilaboð/texti við beiðninni
`files` valfrjálst	array	Skrá(r) sem á að hengja við svarið (krefst `response_file_attachments: true` að beiðni)

Athugið: Aðeins beiðnir í „opnu“ ástandi geta fengið svör. Þegar svar hefur verið sent inn færist beiðnin í „tilbúin“ ástand og ekki er hægt að taka við frekari svörum.

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

Skilar fullgildri leynilegri vefslóð beiðni án þess að sækja efnið.

Dæmi um beiðni

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

Dæmi um svar

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

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

Skilar endurskoðunarskrá fyrir beiðni. 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/requests/orpw2wkg00vpn0a/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"
    },
    {
      "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"
    }
  ]
}

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

DELETE /api/v2/requests/:url_token

Lokar beiðni samstundis og eyðir öllum viðkvæmum gögnum sem tengjast henni varanlega. Þessi aðgerð er óafturkræf og ekki er hægt að afturkalla hana. Krefst auðkenningar og eignarhalds.

Dæmi um beiðni

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

Dæmi um svar

{
  "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://eu.pwpush.com/r/orpw2wkg00vpn0a.json",
  "html_url": "https://eu.pwpush.com/r/orpw2wkg00vpn0a",
  "account_id": 1,
  "note": null,
  "name": null,
  "request": null,
  "response": null,
  "files": []
}

GET /api/v2/requests/active

Skilar síðuskiptum lista yfir virkar (opnar eða tilbúnar) beiðnir. Krefst auðkenningar.

GET /api/v2/requests/open

Skilar síðuskiptum lista yfir opnar beiðnir þínar. Krefst auðkenningar.

GET /api/v2/requests/ready

Skilar síðuskiptum lista yfir tilbúnar beiðnir. Krefst auðkenningar.

GET /api/v2/requests/closed

Skilar síðuskiptum lista yfir lokaðar beiðnir þínar. 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 beiðnum á síðu
Dæmi: ?page=2 að sækja aðra síðuna

Beiðniríki

open

Beiðni um að opna

Beiðnin hefur verið búin til og bíður eftir svari. Beiðnin er sýnileg en ekkert svar hefur borist enn.

ready

Svar tilbúið

Beiðninni hefur verið svarað og hún inniheldur nú svargagnagrunninn. Texti beiðninnar er ekki lengur sýnilegur en svarið er tiltækt til afhendingar.

closed

Lokað

Beiðninni hefur verið svarað og öllum viðkvæmum gögnum (bæði beiðni og svari) hefur verið eytt fyrir fullt og allt. Þetta ástand er óafturkræft.

Dæmi um beiðni (virk)

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

Dæmi um beiðni (opið)

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

Dæmi um beiðni (tilbúin)

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

Dæmi um beiðni (lokað)

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

Dæmi um svar

[
  {
    "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://eu.pwpush.com/r/abc123xyz789.json",
    "html_url": "https://eu.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://eu.pwpush.com/r/def456uvw012.json",
    "html_url": "https://eu.pwpush.com/r/def456uvw012",
    "account_id": 1,
    "note": null,
    "name": null
  }
]

Athugið: Hinn /active endapunktur skilar beiðnum í báðum open og ready ríki. Notið /open eða /ready endapunktar til að sía eftir tilteknu ástandi.

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

Password Pusher API útgáfa 2

Beiðnir

Beiðnir hafa þrjár stöður:

Búa til beiðni

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Tímalengdargildi fyrir `close_after_duration`

Dæmi um beiðni

Sækja beiðni

Dæmi um beiðni

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

Dæmi um svar (opin beiðni)

Dæmi um svar (tilbúin beiðni)

Svara beiðni

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Forskoða beiðni

Dæmi um beiðni

Dæmi um svar

Sækja endurskoðunarskrá beiðni

Dæmi um beiðni

Dæmi um svar

Loka beiðni

Dæmi um beiðni

Dæmi um svar

Beiðni um innheimtu

Beiðniríki

Dæmi um beiðni (virk)

Dæmi um beiðni (opið)

Dæmi um beiðni (tilbúin)

Dæmi um beiðni (lokað)

Dæmi um svar

Password Pusher API útgáfa 2

Beiðnir

Beiðnir hafa þrjár stöður:

Búa til beiðni

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Tímalengdargildi fyrir close_after_duration

Dæmi um beiðni

Sækja beiðni

Dæmi um beiðni

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

Dæmi um svar (opin beiðni)

Dæmi um svar (tilbúin beiðni)

Svara beiðni

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Forskoða beiðni

Dæmi um beiðni

Dæmi um svar

Sækja endurskoðunarskrá beiðni

Dæmi um beiðni

Dæmi um svar

Loka beiðni

Dæmi um beiðni

Dæmi um svar

Beiðni um innheimtu

Beiðniríki

Dæmi um beiðni (virk)

Dæmi um beiðni (opið)

Dæmi um beiðni (tilbúin)

Dæmi um beiðni (lokað)

Dæmi um svar

Tímalengdargildi fyrir `close_after_duration`