Password Pusher API v2

BETAVERSJON

Omfattende REST API-dokumentasjon for integrering Password Pusher inn i applikasjonene dine

Beta-varsel: API v2 er for øyeblikket i betaversjon. Vi har gjort vårt ytterste for å sikre stabilitet, men det kan forekomme endringer før den endelige utgivelsen. Vi tar gjerne imot tilbakemeldinger!

Forespørsler

Forespørsler muliggjør sikker toveiskommunikasjon for innsamling av sensitiv informasjon. Opprett en forespørsel med en hemmelig URL, del den med hvem som helst, og motta sikre svar som inneholder tekst eller filer - alt uten å eksponere sensitive data i e-post, chat eller logger.

Perfekt for innsamling av legitimasjon, API-nøkler, konfidensielle dokumenter eller annen sensitiv informasjon fra kolleger, klienter eller kunder. Svarene krypteres automatisk og slettes automatisk etter en spesifisert varighet for å minimere eksponeringen av data. Full livssyklussporing er tilgjengelig i revisjonsloggene for hver forespørsel.

Forespørsler har tre tilstander:

open Forespørselen er opprettet og venter på svar. Del URL-adressen til forespørselen med mottakeren.

ready Et svar har blitt gitt og er tilgjengelig for henting. Den opprinnelige forespørreren kan nå få tilgang til svaret.

closed Forespørselen har utløpt eller blitt lukket manuelt. Alle sensitive data er slettet permanent.

POST /api/v2/requests

Oppretter en ny forespørsel. Krever autentisering.

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` nødvendig	string	Forespørselsteksten/meldingen som skal deles
`close_after_duration` valgfri	integer (0-17)	Duration enum - når forespørselen skal lukkes
`passphrase` valgfri	string	Krev at mottakerne oppgir denne passordfrasen for å se
`name` valgfri	string	Et navn som vises på dashbordet, i varsler og e-poster
`note` valgfri	string	Intern merknad (kun synlig for opphavsmannen)
`retrieval_step` valgfri	boolean	Bidrar til å unngå at chat-systemer og URL-skannere spiser opp visninger
`include_requestor` valgfri	boolean	Inkluder informasjon om rekvirenten i forespørselen
`response_file_attachments` valgfri	boolean	Tillat filvedlegg i svar
`files` valgfri	array	Fil(er) som skal lastes opp og legges ved forespørselen
`notify_emails_to` valgfri	string	E-postadresser som skal varsles når en forespørsel opprettes (kommaseparert)
`notify_emails_to_locale` valgfri	string	Lokalitet (språk) for å sende e-postvarsling(er) på
`account_id` valgfri	integer	Konto-ID-en som forespørselen skal knyttes til

Varighet Verdier for `close_after_duration`

0: 15 minutter

1: 30 minutter

2: 45 minutter

3: 1 time

4: 6 timer

5: 12 timer

6: 1 dag

7: 2 dager

8: 3 dager

9: 4 dager

10: 5 dager

11: 6 dager

12: 1 uke

13: 2 uker

14: 3 uker

15: 1 måned

16: 2 måneder

17: 3 måneder

Eksempel på forespørsel

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

Henter innholdet i en åpen eller klar forespørsel. Dette kan lukke forespørselen hvis den er konfigurert til å lukkes etter et visst antall visninger.

Eksempel på forespørsel

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

Eksempel på forespørsel med passordfrase

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

Eksempel på svar (åpen forespørsel)

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

Eksempel på svar (Klar-forespørsel)

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

Merk: Hvis forespørselen har en passordfrase, inkluderer du den som en spørringsparameter: ?passphrase=your_passphrase. Å hente en forespørsel teller som en visning og kan føre til at forespørselen lukkes hvis den når visningsgrensen.

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

Svarer på en åpen forespørsel og endrer status til "klar".

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

Parameter	Type	Beskrivelse
`response` nødvendig	string	Svarteksten/meldingen til forespørselen
`files` valgfri	array	Fil(er) som skal legges ved svaret (krever `response_file_attachments: true` på forespørselen)

Merk: Bare forespørsler i tilstanden "åpen" kan motta svar. Når et svar er sendt inn, går forespørselen over i tilstanden "klar" og kan ikke ta imot flere svar.

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

Returnerer den fullt kvalifiserte hemmelige URL-en til en forespørsel uten å hente innholdet.

Eksempel på forespørsel

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

Eksempel på svar

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

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

Returnerer revisjonsloggen for en forespørsel. Krever autentisering og eierskap.

Parametere for spørring:

page (valgfri): Sidetall for paginering.

Standard: 1 (første side)
Rekkevidde: 1 til 200
Returnerer opptil 50 revisjonsloggoppføringer per side
Eksempel: ?page=2 for å hente den andre siden

Eksempel på forespørsel

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

Eksempel på 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"
    }
  ]
}

Merk: Den kind feltet angir hvilken type handling som logges. Vanlige verdier inkluderer: creation, view, response, close, failed_passphrase, og failed_view.

DELETE /api/v2/requests/:url_token

Lukker en forespørsel umiddelbart og sletter alle sensitive data som er knyttet til den, permanent. Denne handlingen er irreversibel og kan ikke angres. Krever autentisering og eierskap.

Eksempel på forespørsel

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

Eksempel på 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

Returnerer en paginert liste over dine aktive (åpne eller klare) forespørsler. Krever autentisering.

GET /api/v2/requests/open

Returnerer en paginert liste over dine åpne forespørsler. Krever autentisering.

GET /api/v2/requests/ready

Returnerer en paginert liste over dine klare forespørsler. Krever autentisering.

GET /api/v2/requests/closed

Returnerer en paginert liste over dine lukkede forespørsler. Krever autentisering.

Parametere for spørring:

page (valgfri): Sidetall for paginering.

Standard: 1 (første side)
Rekkevidde: 1 til 200
Returnerer opptil 50 forespørsler per side
Eksempel: ?page=2 for å hente den andre siden

Forespørsel stater

open

Åpne

Forespørselen er opprettet og venter på svar. Forespørselsteksten er synlig, men det er ikke gitt noe svar ennå.

ready

Svar klar

Forespørselen er besvart og inneholder nå svarets nyttelast. Forespørselsteksten er ikke lenger synlig, men svaret er tilgjengelig for henting.

closed

Lukket

Forespørselen er håndtert, og alle sensitive data (både forespørsel og svar) er slettet permanent. Denne tilstanden er irreversibel.

Eksempel på forespørsel (aktiv)

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

Eksempel på forespørsel (åpen)

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

Eksempel på forespørsel (klar)

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

Eksempel på forespørsel (lukket)

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

Eksempel på 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
  }
]

Merk: Den /active endepunkt returnerer forespørsler i både open og ready stater. Bruk /open eller /ready endepunkter for å filtrere etter en bestemt tilstand.

Sist oppdatert: July 12, 2026

Password Pusher API v2

Forespørsler

Forespørsler har tre tilstander:

Opprett en forespørsel

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Varighet Verdier for `close_after_duration`

Eksempel på forespørsel

Hent en forespørsel

Eksempel på forespørsel

Eksempel på forespørsel med passordfrase

Eksempel på svar (åpen forespørsel)

Eksempel på svar (Klar-forespørsel)

Svar på en forespørsel

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Forhåndsvis en forespørsel

Eksempel på forespørsel

Eksempel på svar

Hent revisjonslogg for forespørsler

Eksempel på forespørsel

Eksempel på svar

Lukk en forespørsel

Eksempel på forespørsel

Eksempel på svar

Be om samlinger

Forespørsel stater

Eksempel på forespørsel (aktiv)

Eksempel på forespørsel (åpen)

Eksempel på forespørsel (klar)

Eksempel på forespørsel (lukket)

Eksempel på svar

Password Pusher API v2

Forespørsler

Forespørsler har tre tilstander:

Opprett en forespørsel

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Varighet Verdier for close_after_duration

Eksempel på forespørsel

Hent en forespørsel

Eksempel på forespørsel

Eksempel på forespørsel med passordfrase

Eksempel på svar (åpen forespørsel)

Eksempel på svar (Klar-forespørsel)

Svar på en forespørsel

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Forhåndsvis en forespørsel

Eksempel på forespørsel

Eksempel på svar

Hent revisjonslogg for forespørsler

Eksempel på forespørsel

Eksempel på svar

Lukk en forespørsel

Eksempel på forespørsel

Eksempel på svar

Be om samlinger

Forespørsel stater

Eksempel på forespørsel (aktiv)

Eksempel på forespørsel (åpen)

Eksempel på forespørsel (klar)

Eksempel på forespørsel (lukket)

Eksempel på svar

Varighet Verdier for `close_after_duration`