Password Pusher-logo
Password Share

Password Pusher API v2

Komplet JSON API-dokumentation til oprettelse, hentning og administration af pushes i open source-udgaven.

Autentificering

Godkend anmodninger med et Bearer-token i Authorization-headeren. 

Authorization: Bearer YOUR_API_TOKEN
  • Offentlige slutpunkter: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
  • Godkendte slutpunkter: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
  • Indstilling for anonym adgang: Når anonyme pushs er deaktiveret, kræver API-slutpunkter godkendelse.

Basis-URL

Alle slutpunkter er relative til din installationsvært:

https://pwshare.complea.dk/api/v2

Versionsslutpunkt

GET /api/v2/version

Returnerer API- og applikationsversionsoplysninger.

cURL-eksempel:

curl -X GET https://pwshare.complea.dk/api/v2/version
{
  "application_version": "2.4.3",
  "api_version": "2.0",
  "edition": "oss"
}

Push-endepunkter

POST /api/v2/pushes

Opret et nyt push.

Kropsformat: { "push": { ... } }

Parameter Type Påkrævet Beskrivelse
payloadstringJaHemmelig tekstnyttelast til tekst-, URL- eller QR-pushs.
filesarrayIngenFiler, der skal vedhæftes. Når push-typen er til stede, bliver den til fil, medmindre typen eksplicit er angivet.
kindstringIngenPush-type: tekst, fil, url eller qr. Standardindstillingen er tekst, når den ikke angives.
expire_after_daysintegerIngenUdløbsvindue i dage. Hvis udeladt, bruges instansstandarder.
expire_after_viewsintegerIngenMaksimalt tilladt antal hentninger. Hvis det udelades, bruges standardværdierne for instanser.
deletable_by_viewerbooleanIngenGiver modtageren mulighed for at udløbe pushet.
retrieval_stepbooleanIngenTilføjer et ekstra trin til bekræftelse af hentning.
passphrasestringIngenKræver denne adgangskode for at hente nyttelasten.
namestringIngenValgfri etiket vist til ejeren.
notestringIngenValgfri bemærkning kun til ejeren.
 
{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

cURL-eksempel (JSON-brødtekst):

curl -X POST https://pwshare.complea.dk/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

Hent en push-nyttelast via token. Dette tæller som en visning og kan udløbe pushet, når grænserne er nået.

Forespørgselsparametre: passphrase (valgfri, påkrævet når push'en er beskyttet med en adgangskode)

cURL-eksempel:

curl -X GET https://pwshare.complea.dk/api/v2/pushes/YOUR_URL_TOKEN

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

Returnerer den fuldt kvalificerede hemmelige URL for et push uden at hente dens nyttelast.

cURL-eksempel:

curl -X GET https://pwshare.complea.dk/api/v2/pushes/YOUR_URL_TOKEN/preview

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

Returner poster i revisionslogfiler for et push-push. Godkendelse og ejerskab er påkrævet.

Forespørgselsparametre: page (valgfri, heltal, standard 1, gyldigt område 1 til 200)

cURL-eksempel:

curl -X GET "https://pwshare.complea.dk/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Udløber et push med det samme. Tilladt for ejere (når godkendt) eller for modtagere, når pushet blev oprettet med deletable_by_viewer aktiveret.

cURL-eksempel:

curl -X DELETE https://pwshare.complea.dk/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

Angiv aktive pushs for den godkendte bruger.

Forespørgselsparametre: page (valgfri, heltal, standard 1, gyldigt område 1 til 200)

cURL-eksempel:

curl -X GET "https://pwshare.complea.dk/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Angiv udløbne push-kampagner for den godkendte bruger.

Forespørgselsparametre: page (valgfri, heltal, standard 1, gyldigt område 1 til 200)

cURL-eksempel:

curl -X GET "https://pwshare.complea.dk/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

HTTP-statuskoder

  • 200 - Anmodning gennemført
  • 201 - Push oprettet
  • 400 - Ugyldige anmodningsparametre
  • 401 - Godkendelse kræves eller ugyldig token
  • 403 - Forbudt for nuværende bruger
  • 404 - Ressource ikke fundet
  • 422 - Valideringsfejl

For dokumentation for ældre API v1, se /api.