Password Pusher API versió 2

BETA

Documentació completa de l'API REST per a la integració Password Pusher a les vostres aplicacions

Avís beta: L'API v2 està actualment en versió beta. Tot i que hem fet tot el possible per garantir l'estabilitat, és possible que hi hagi canvis importants abans del llançament final. Agraïm els vostres comentaris!

Sol·licituds

Les sol·licituds permeten una comunicació bidireccional segura per recopilar informació confidencial. Creeu una sol·licitud amb una URL secreta, compartiu-la amb qui vulgueu i rebeu respostes segures que continguin text o fitxers, tot sense exposar dades confidencials al correu electrònic, al xat o als registres.

Perfecte per recopilar credencials, claus API, documents confidencials o qualsevol informació sensible de col·legues, clients o usuaris. Les respostes es xifren automàticament i s'eliminen automàticament després d'un període especificat per minimitzar l'exposició de dades. El seguiment complet del cicle de vida està disponible als registres d'auditoria de cada sol·licitud.

Les sol·licituds tenen tres estats:

open La sol·licitud s'ha creat i està esperant una resposta. Comparteix l'URL de la sol·licitud amb el destinatari.

ready S'ha proporcionat una resposta i està disponible per a la seva recuperació. El sol·licitant original ara pot accedir a la resposta.

closed La sol·licitud ha caducat o s'ha tancat manualment. Totes les dades sensibles s'han suprimit permanentment.

POST /api/v2/requests

Crea una nova sol·licitud. Requereix autenticació.

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://us.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` requerit	string	El text/missatge de sol·licitud per compartir
`close_after_duration` opcional	integer (0-17)	Enumeració de durada: quan tancar la sol·licitud
`passphrase` opcional	string	Demana als destinataris que introdueixin aquesta contrasenya per veure
`name` opcional	string	Un nom que es mostra al tauler de control, a les notificacions i als correus electrònics
`note` opcional	string	Nota interna (només visible per al creador)
`retrieval_step` opcional	boolean	Ajuda a evitar que els sistemes de xat i els escàners d'URL consumeixin les visualitzacions
`include_requestor` opcional	boolean	Incloure la informació del sol·licitant a la sol·licitud
`response_file_attachments` opcional	boolean	Permetre fitxers adjunts a les respostes
`files` opcional	array	Fitxer(s) per carregar i adjuntar a la sol·licitud
`notify_emails_to` opcional	string	Adreces de correu electrònic per rebre notificacions quan es creï una sol·licitud (separades per comes)
`notify_emails_to_locale` opcional	string	Configuració regional (idioma) per enviar notificacions per correu electrònic
`authenticated_recipients` opcional	boolean	Requereix verificació OTP del correu electrònic abans d'accedir. Requereix notify_emails_to. Només per a navegador quan està habilitat (l'API de recuperació/resposta retorna 403).
`account_id` opcional	integer	L'ID del compte amb què s'associarà la sol·licitud

Valors de durada per a `close_after_duration`

0: 15 minuts

1: 30 minuts

2: 45 minuts

3: 1 hora

4: 6 hores

5: 12 hores

6: 1 dia

7: 2 dies

8: 3 dies

9: 4 dies

10: 5 dies

11: 6 dies

12: 1 setmana

13: 2 setmanes

14: 3 setmanes

15: 1 mes

16: 2 mesos

17: 3 mesos

Exemple de sol·licitud

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

$response | ConvertTo-Json

GET /api/v2/requests/:url_token

Recupera el contingut d'una sol·licitud oberta o a punt. Això pot tancar la sol·licitud si està configurada per tancar-se després d'un cert nombre de visualitzacions.

Exemple de sol·licitud

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

Exemple de sol·licitud amb contrasenya

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

Exemple de resposta (sol·licitud oberta)

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

Exemple de resposta (sol·licitud preparada)

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

Nota: Si la sol·licitud té una contrasenya, incloeu-la com a paràmetre de consulta: ?passphrase=your_passphrase. Recuperar una sol·licitud compta com una visualització i pot tancar la sol·licitud si arriba al límit de visualitzacions.

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

Respon a una sol·licitud oberta, canviant el seu estat a "ready" (preparat).

Request Body (JSON)

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

Request Body with Files (multipart/form-data)

curl -X PATCH https://us.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

Paràmetre	Tipus	Descripció
`response` requerit	string	El text/missatge de resposta a la sol·licitud
`files` opcional	array	Fitxer(s) per adjuntar a la resposta (requereix) `response_file_attachments: true` a petició)

Nota: Només les sol·licituds en estat "obert" poden rebre respostes. Un cop enviada una resposta, la sol·licitud passa a l'estat "preparada" i no pot acceptar respostes addicionals.

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

Retorna l'URL secreta completa d'una sol·licitud sense recuperar-ne el contingut.

Exemple de sol·licitud

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

Exemple de resposta

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

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

Retorna el registre d'auditoria d'una sol·licitud. Requereix autenticació i propietat.

Paràmetres de consulta:

page (opcional): Número de pàgina per a la paginació.

Per defecte: 1 (primera pàgina)
Rang: 1 a 200
Retorna fins a 50 entrades de registre d'auditoria per pàgina
Exemple: ?page=2 per recuperar la segona pàgina

Exemple de sol·licitud

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

Exemple de resposta

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

Nota: El kind El camp indica el tipus d'acció registrada. Els valors comuns inclouen: creation, view, response, close, failed_passphrase, i failed_view.

DELETE /api/v2/requests/:url_token

Tanca immediatament una sol·licitud i elimina permanentment totes les dades sensibles associades. Aquesta acció és irreversible i no es pot desfer. Requereix autenticació i propietat.

Exemple de sol·licitud

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

Exemple de resposta

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

GET /api/v2/requests/active

Retorna una llista paginada de les sol·licituds actives (obertes o llestes). Requereix autenticació.

GET /api/v2/requests/open

Retorna una llista paginada de les sol·licituds obertes. Requereix autenticació.

GET /api/v2/requests/ready

Retorna una llista paginada de les sol·licituds llestes. Requereix autenticació.

GET /api/v2/requests/closed

Retorna una llista paginada de les sol·licituds tancades. Cal autenticació.

Paràmetres de consulta:

page (opcional): Número de pàgina per a la paginació.

Per defecte: 1 (primera pàgina)
Rang: 1 a 200
Retorna fins a 50 sol·licituds per pàgina
Exemple: ?page=2 per recuperar la segona pàgina

Estats sol·licitants

open

Sol·licitud oberta

La sol·licitud s'ha creat i està esperant una resposta. El text de la sol·licitud és visible, però encara no s'ha proporcionat cap resposta.

ready

A punt

S'ha respost a la sol·licitud i ara conté la càrrega útil de la resposta. El text de la sol·licitud ja no és visible, però la resposta està disponible per a la seva recuperació.

closed

Tancat

La sol·licitud s'ha gestionat i totes les dades sensibles (tant la sol·licitud com la resposta) s'han suprimit permanentment. Aquest estat és irreversible.

Exemple de sol·licitud (activa)

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

Exemple de sol·licitud (oberta)

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

Exemple de sol·licitud (llest)

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

Exemple de sol·licitud (tancada)

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

Exemple de resposta

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

Nota: El /active el punt final retorna sol·licituds en ambdós open i ready estats. Ús /open o /ready punts finals per filtrar per estat específic.

Darrera actualització: July 20, 2026

Password Pusher API versió 2

Sol·licituds

Les sol·licituds tenen tres estats:

Crea una sol·licitud

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Valors de durada per a `close_after_duration`

Exemple de sol·licitud

Recuperar una sol·licitud

Exemple de sol·licitud

Exemple de sol·licitud amb contrasenya

Exemple de resposta (sol·licitud oberta)

Exemple de resposta (sol·licitud preparada)

Respondre a una sol·licitud

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Vista prèvia d'una sol·licitud

Exemple de sol·licitud

Exemple de resposta

Obtenir registre d'auditoria de sol·licituds

Exemple de sol·licitud

Exemple de resposta

Tanca una sol·licitud

Exemple de sol·licitud

Exemple de resposta

Sol·licitar col·leccions

Estats sol·licitants

Exemple de sol·licitud (activa)

Exemple de sol·licitud (oberta)

Exemple de sol·licitud (llest)

Exemple de sol·licitud (tancada)

Exemple de resposta

Password Pusher API versió 2

Sol·licituds

Les sol·licituds tenen tres estats:

Crea una sol·licitud

Request Body (JSON)

Request Body with Files (multipart/form-data)

Parameters

Valors de durada per a close_after_duration

Exemple de sol·licitud

Recuperar una sol·licitud

Exemple de sol·licitud

Exemple de sol·licitud amb contrasenya

Exemple de resposta (sol·licitud oberta)

Exemple de resposta (sol·licitud preparada)

Respondre a una sol·licitud

Request Body (JSON)

Request Body with Files (multipart/form-data)

Params

Vista prèvia d'una sol·licitud

Exemple de sol·licitud

Exemple de resposta

Obtenir registre d'auditoria de sol·licituds

Exemple de sol·licitud

Exemple de resposta

Tanca una sol·licitud

Exemple de sol·licitud

Exemple de resposta

Sol·licitar col·leccions

Estats sol·licitants

Exemple de sol·licitud (activa)

Exemple de sol·licitud (oberta)

Exemple de sol·licitud (llest)

Exemple de sol·licitud (tancada)

Exemple de resposta

Valors de durada per a `close_after_duration`