Password Pusher logo
NLG-System Biztonságos jelszómegosztás

Password Pusher API v2

Teljes JSON API dokumentáció a push üzenetek létrehozásához, lekéréséhez és kezeléséhez a nyílt forráskódú kiadásban.

Hitelesítés

Hitelesítse a kéréseket egy Bearer tokennel az Authorization fejlécben.

Hozz létre egy API tokent a fiókbeállításaidban a következő címen: /users/token. 

Authorization: Bearer YOUR_API_TOKEN
  • Nyilvános végpontok: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
  • Hitelesített végpontok: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
  • Névtelen hozzáférés beállítása: Ha a névtelen push-ek le vannak tiltva, az API-végpontok hitelesítést igényelnek.

Bázis URL

Minden végpont relatív a telepítési gazdagéphez képest:

https://secure.nlg.cloud/api/v2

Verzió végpont

GET /api/v2/version

Visszaadja az API verzióját, az alkalmazás részleteit és egy funkcióhash-t, amely leírja, hogy mely képességek vannak engedélyezve ebben a példányban.

cURL példa:

curl -X GET https://secure.nlg.cloud/api/v2/version
{
  "application_version": "2.6.5",
  "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": false,
        "requires_authentication": true
      },
      "url_pushes": {
        "enabled": false
      },
      "qr_code_pushes": {
        "enabled": false
      }
    },
    "requests": {
      "enabled": false
    }
  }
}

Jellemzők Hash

  • anonymous_access - Engedélyezett-e az anonim API-használat (Settings.allow_anonymous)
  • api_token_authentication - Bearer token hitelesítési támogatás
  • accounts.enabled - Fiókok API elérhetősége (nem érhető el az OSS-ben)
  • pushes.enabled - Push létrehozása és kezelése API-n keresztül
  • pushes.file_attachments.enabled - Fájlmellékletek push üzenetekhez (Settings.enable_file_pushes)
  • pushes.url_pushes.enabled - URL push típusa (Settings.enable_url_pushes)
  • pushes.qr_code_pushes.enabled - QR-kód push típusa (Settings.enable_qr_pushes)
  • requests.enabled - API elérhetőségét kéri (nem érhető el OSS-ben)

Push végpontok

POST /api/v2/pushes

Hozz létre egy új törlést.

Törzs formátuma: { "push": { ... } }

Paraméter Típus Kívánt Leírás
payloadstringIgenTitkos szöveges hasznos adat szöveges, URL- vagy QR-kódos push-okhoz.
filesarrayNemCsatolni kívánt fájlok. Ha jelen van, a push típus fájl lesz, kivéve, ha a típus explicit módon meg van adva.
kindstringNemPush típusa: szöveg, fájl, URL vagy QR-kód. Alapértelmezés szerint szöveg, ha nincs megadva.
expire_after_daysintegerNemLejárati ablak napokban. Ha nincs megadva, a példány alapértelmezett értékei kerülnek felhasználásra.
expire_after_viewsintegerNemMaximálisan megengedett lekérések száma. Ha nincs megadva, a példány alapértelmezett értékei kerülnek felhasználásra.
deletable_by_viewerbooleanNemLehetővé teszi a címzett számára a push lejártát.
retrieval_stepbooleanNemHozzáad egy extra lekérési megerősítési lépést.
passphrasestringNemEz a jelszó szükséges a hasznos adat lekéréséhez.
namestringNemOpcionális címke, amelyet a tulajdonosnak mutatnak.
notestringNemOpcionális, csak a tulajdonosnak szóló megjegyzés.
 
{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

cURL példa (JSON törzs):

curl -X POST https://secure.nlg.cloud/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

Push adatcsomag lekérése token alapján. Ez megtekintésnek számít, és a push kérelmet lemondhatja a korlátok elérésekor.

Lekérdezési paraméterek: passphrase (opcionális, kötelező, ha a push jelszóval védett)

cURL példa:

curl -X GET https://secure.nlg.cloud/api/v2/pushes/YOUR_URL_TOKEN

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

Visszaadja egy push művelet teljesen minősített titkos URL-címét a hasznos adat lekérése nélkül.

cURL példa:

curl -X GET https://secure.nlg.cloud/api/v2/pushes/YOUR_URL_TOKEN/preview

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

Naplóbejegyzések visszaadása push esetén. Hitelesítés és tulajdonjog szükséges.

Lekérdezési paraméterek: page (opcionális, egész szám, alapértelmezett 1, érvényes tartomány 1 és 200 között)

cURL példa:

curl -X GET "https://secure.nlg.cloud/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Azonnal lejár egy push üzenet. Engedélyezett a tulajdonosok számára (hitelesítés esetén) vagy a címzettek számára, ha a push üzenetet engedélyezve lévő deletable_by_viewer beállítással hozták létre.

cURL példa:

curl -X DELETE https://secure.nlg.cloud/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

A hitelesített felhasználó aktív push-es üzeneteinek listázása.

Lekérdezési paraméterek: page (opcionális, egész szám, alapértelmezett 1, érvényes tartomány 1 és 200 között)

cURL példa:

curl -X GET "https://secure.nlg.cloud/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Lejárt push üzenetek listázása a hitelesített felhasználóhoz.

Lekérdezési paraméterek: page (opcionális, egész szám, alapértelmezett 1, érvényes tartomány 1 és 200 között)

cURL példa:

curl -X GET "https://secure.nlg.cloud/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

HTTP állapotkódok

  • 200 - Sikeres kérés
  • 201 - Push létrehozva
  • 400 - Érvénytelen kérésparaméterek
  • 401 - Hitelesítés szükséges vagy érvénytelen token
  • 403 - A jelenlegi felhasználó számára tiltott
  • 404 - Az erőforrás nem található
  • 422 - Érvényesítési hiba

A korábbi API v1 dokumentációját lásd: /api.