Password Pusher API v2

Autenticación

Autentica las solicitudes con un token Bearer en el encabezado de autorización.

Cree un token de API en la configuración de su cuenta en /users/token.

Authorization: Bearer YOUR_API_TOKEN

• Puntos de acceso públicos: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
• Puntos finales autenticados: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
• Configuración de acceso anónimo: Cuando se desactivan las notificaciones push anónimas, los puntos finales de la API requieren autenticación.

URL base

Todos los puntos finales son relativos al host de instalación:

https://pswpsh.jumapa.in/api/v2

Punto final de versión

GET /api/v2/version

Devuelve la versión de la API, los detalles de la aplicación y un hash de características que describe qué capacidades están habilitadas en esta instancia.

Ejemplo de cURL:

curl -X GET https://pswpsh.jumapa.in/api/v2/version

{
  "application_version": "2.7.3",
  "api_version": "2.1",
  "edition": "oss",
  "features": {
    "anonymous_access": true,
    "api_token_authentication": true,
    "accounts": {
      "enabled": false
    },
    "pushes": {
      "enabled": true,
      "email_auto_dispatch": false,
      "file_attachments": {
        "enabled": true,
        "requires_authentication": true
      },
      "url_pushes": {
        "enabled": true
      },
      "qr_code_pushes": {
        "enabled": true
      }
    },
    "requests": {
      "enabled": false
    }
  }
}

POST /api/v2/pushes

Crea una nueva solicitud push.

Formato del cuerpo: { "push": { ... } }

{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

Ejemplo de cURL (cuerpo JSON):

curl -X POST https://pswpsh.jumapa.in/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "my-secret",
      "expire_after_days": 1,
      "expire_after_views": 5
    }
  }'

GET /api/v2/pushes/:url_token

Recupera una carga útil de envío mediante token. Esto cuenta como una visualización y puede provocar que el envío caduque al alcanzar los límites.

Parámetros de consulta: passphrase (Opcional, obligatorio cuando la notificación push está protegida con contraseña.)

Ejemplo de cURL:

curl -X GET https://pswpsh.jumapa.in/api/v2/pushes/YOUR_URL_TOKEN

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

Devuelve la URL secreta completa para una notificación push sin recuperar su carga útil.

Ejemplo de cURL:

curl -X GET https://pswpsh.jumapa.in/api/v2/pushes/YOUR_URL_TOKEN/preview

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

Devuelve las entradas del registro de auditoría para una operación push. Se requiere autenticación y propiedad.

Parámetros de consulta: page (Opcional, entero, valor predeterminado 1, rango válido de 1 a 200.)

Ejemplo de cURL:

curl -X GET "https://pswpsh.jumapa.in/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Caducar una notificación push inmediatamente. Permitido para los propietarios (cuando estén autenticados) o para los destinatarios cuando la notificación se haya creado con la opción `deletable_by_viewer` habilitada.

Ejemplo de cURL:

curl -X DELETE https://pswpsh.jumapa.in/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

Lista las notificaciones push activas para el usuario autenticado.

Parámetros de consulta: page (Opcional, entero, valor predeterminado 1, rango válido de 1 a 200.)

Ejemplo de cURL:

curl -X GET "https://pswpsh.jumapa.in/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Lista las notificaciones push caducadas del usuario autenticado.

Parámetros de consulta: page (Opcional, entero, valor predeterminado 1, rango válido de 1 a 200.)

Ejemplo de cURL:

curl -X GET "https://pswpsh.jumapa.in/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Códigos de estado HTTP

• 200 - Solicitud exitosa
• 201 - Empujar creado
• 400 - Parámetros de solicitud no válidos
• 401 - Se requiere autenticación o el token no es válido.
• 403 - Prohibido para el usuario actual
• 404 - Recurso no encontrado
• 422 - Error de validación