Password Pusher API v2
BETAKomplexná dokumentácia REST API na integráciu aplikácie Password Pusher do vašich pracovných postupov, aplikácií a nástrojov.
Oznámenie o beta verzii: Rozhranie API v2 je v súčasnosti vo fáze beta. Hoci sme vynaložili maximálne úsilie na zabezpečenie stability, pred konečným vydaním sa môžu vyskytnúť zmeny. Uvítame vašu spätnú väzbu!
Prehľad
Rozhranie API Password Pusher v2 poskytuje rozhranie RESTful na vytváranie, načítanie a správu zabezpečených odoslaní a požiadaviek na heslá. Všetky koncové body API vracajú odpovede JSON a používajú štandardné stavové kódy HTTP.
Overovanie tokenov na doručiteľa
Zabezpečený prístup k rozhraniu API pomocou overovania na základe tokenu
Odpovede len vo formáte JSON
Konzistentný formát JSON vo všetkých koncových bodoch
Návrh RESTful
Intuitívne koncové body REST podľa osvedčených postupov
Tlačenia a požiadavky
Podpora jednosmerných a obojsmerných požiadaviek
Generátor hesiel
Vytvorte heslá, heslové frázy a PIN kódy prostredníctvom metódy POST na adrese /api/v2/generate
Rozhranie API v2 používa overovanie pomocou tokenu nosiča. Ak chcete autentifikovať, uveďte svoj token API do Authorization záhlavie:
Authorization: Bearer YOUR_API_TOKEN
Získanie tokenu API
- Prihláste sa do svojho konta Password Pusher
- Prejdite na stránku s tokénmi API
- Generovanie tokenu API
- Skopírujte token a použite ho v požiadavkách API
Poznámka: Niektoré koncové body (napríklad načítanie push správy alebo požiadavky, prípadne generovanie hesla) sú dostupné anonymne. Vytváranie požiadaviek, prístup k auditovým protokolom a správa zbierok si vyžadujú overenie. Ak potrebujete uplatniť zásadu pracovného priestoru vyžadujúcu prihlásenie, do generovaných požiadaviek zahrňte token typu „Bearer“.
Všetky koncové body API majú predponu:
https://eu.pwpush.com/api/v2
Dostupnosť beta verzie
Rozhranie API v2 je v súčasnosti v beta verzii a je k dispozícii na pwpush.com a samostatne hostované verzie Pro. Rozhranie API bude pridané do edície s otvoreným zdrojovým kódom po ukončení beta verzie.
V prípade inštancií s vlastným hostiteľom použite vlastnú doménu. Vyššie uvedená základná adresa URL odráža aktuálneho hostiteľa, ku ktorému pristupujete.
GET /api/v2/version
Vráti aktuálnu verziu API, podrobnosti o aplikácii a hash funkcií popisujúci, ktoré funkcie sú v tejto inštancii povolené.
Príklad žiadosti
curl -X GET https://eu.pwpush.com/api/v2/version
Príklad reakcie
{
"application_version": "2.1.0",
"api_version": "2.1",
"edition": "commercial",
"features": {
"anonymous_access": true,
"api_token_authentication": true,
"password_generator": {
"enabled": true,
"languages": ["de", "en", "es", "fr", "it"]
},
"accounts": {
"enabled": true
},
"pushes": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
},
"requests": {
"enabled": true,
"email_auto_dispatch": true,
"file_attachments": {
"enabled": true,
"requires_authentication": true
}
}
}
}
Vlastnosti Hash
anonymous_access - Či je povolené anonymné používanie API
api_token_authentication - Podpora overovania pomocou tokenu nosiča
password_generator.enabled - Či je povolené generovanie hesiel, heslových fráz a PIN kódov
password_generator.jazyky - Jazyky zoznamov slov podporovaných pre heslá
accounts.enabled - Či je výpis pracovných priestorov dostupný na adrese /api/v2/workspaces (staršia cesta /api/v2/accounts je alias)
pushes.enabled - Vytváranie a správa tlačidiel Push prostredníctvom rozhrania API
pushes.email_auto_dispatch - Či táto inštancia môže pri vytvorení odosielať tajné odkazy e-mailom. Iba na účely zistenia funkčnosti — ak chcete deaktivovať funkciu automatického odosielania, použite parameter `notify_recipients` pri vytvorení, pričom naďalej zadávajte parameter `notify_emails_to` pre overených príjemcov.
pushes.file_attachments.enabled - Prílohy súborov na tlačidlách
pushes.file_attachments.requires_authentication - Prílohy súborov vyžadujú overenie
requests.enabled - Vytváranie a správa požiadaviek prostredníctvom rozhrania API
requests.email_auto_dispatch - Či táto inštancia môže pri vytvorení odosielať tajné odkazy e-mailom. Iba na účely zistenia funkčnosti — ak chcete deaktivovať funkciu automatického odosielania, použite parameter `notify_recipients` pri vytvorení, pričom naďalej zadávajte parameter `notify_emails_to` pre overených príjemcov.
requests.file_attachments.enabled - Prílohy súborov v odpovediach na žiadosti
requests.file_attachments.requires_authentication - Prílohy súborov vyžadujú overenie
POST /api/v2/generate
Vytvorí jedno alebo viacero hesiel, heselných fráz alebo PIN kódov. Overovanie je voliteľné. Anonymné požiadavky využívajú zásady základného pracovného priestoru (alebo globálneho pracovného priestoru s vlastným hosťovaním). Ak chcete používať zásady prihláseného pracovného priestoru, vrátane vlastných domén, je potrebné odoslať token typu „Bearer“.
Ak je konfigurácia generátora zakázaná na základe pravidiel, prepisovanie nastavení sa ignoruje a zohľadňuje sa iba počet.
Ak je generovanie hesla deaktivované, rozhranie API vráti stav 403 Forbidden.
Generovanie je obmedzené na 30 požiadaviek za minútu na jednu IP adresu alebo na jedného overeného používateľa.
Telo požiadavky (JSON)
Parametre odošlite v koreňovej časti objektu JSON. V prípade vynechaných polí sa použijú predvolené hodnoty platných pravidiel.
| Parameter | Typ | Popis |
|---|---|---|
workspace_id
voliteľné
|
string | Overený pracovný priestor, z ktorého sa má uplatniť zásada. Prijíma aj parameter account_id. Vráti kód 401, ak volajúci nie je členom daného pracovného priestoru. |
type
voliteľné
|
string | heslo, heslová fráza alebo PIN |
count
voliteľné
|
integer (1-10) | Počet hodnôt, ktoré sa majú vygenerovať |
language
voliteľné
|
string | Zoznam hesiel: en, es, fr, de alebo it |
word_count
voliteľné
|
integer (3-10) | Počet slov v hesle |
separator
voliteľné
|
string | Reťazec vložený medzi slová hesla |
capitalize
voliteľné
|
boolean | Každé slovo v hesle napíšte s veľkým začiatočným písmenom |
number
voliteľné
|
boolean | Pridať číslice k heslu |
symbol
voliteľné
|
boolean | Pridať symbol k heslu |
length
voliteľné
|
integer | Dĺžka hesla (4–128) alebo dĺžka PIN kódu (4–12) |
uppercase
voliteľné
|
boolean | Do hesiel zahrňte veľké písmená |
lowercase
voliteľné
|
boolean | Do hesiel zahrňte malé písmená |
digits
voliteľné
|
boolean | Do hesiel zahrňte číslice |
symbols
voliteľné
|
boolean | Do hesiel vkladajte symboly |
avoid_ambiguous
voliteľné
|
boolean | Vylúčte znaky, ktoré sa dajú zameniť, ako napríklad 0, O, l a 1 |
min_digits
voliteľné
|
integer | Minimálny počet číslic v hesle |
min_symbols
voliteľné
|
integer | Minimálny počet znakov v hesle |
charset
voliteľné
|
string | Prednastavenie znakov: ASCII, latinka, cyrilika alebo gréčtina. Akákoľvek iná hodnota sa považuje za vlastnú sadu znakov. |
Polia odpovede
| Pole | Popis |
|---|---|
type |
heslo, heslová fráza alebo PIN |
language |
Hodnota pre prístupové frázy. Zoznam slov použitý na generovanie výsledku. |
entropy_bits |
Odhadovaná pevnosť uvedená v odpovedi. Pozri entropia ako meradlo sily hesla. |
results |
Pole vygenerovaných reťazcov |
Príklad žiadosti
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Content-Type: application/json" \
-d '{
"type": "passphrase",
"language": "en",
"word_count": 4,
"count": 2
}'
Príklad reakcie
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}
Príklad hesla
curl -X POST https://eu.pwpush.com/api/v2/generate \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"type": "password",
"length": 20,
"symbols": true
}'
Príklad: Vytvorenie a načítanie tlačidla
# Create a push
curl -X POST https://eu.pwpush.com/api/v2/pushes \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"push": {
"payload": "MySecretPassword123",
"expire_after_duration": 6,
"expire_after_views": 3
}
}'
# Retrieve the push
curl -X GET https://eu.pwpush.com/api/v2/pushes/fkwjfvhall92
Príklad: Vytvorenie žiadosti a odpoveď
# Create a request
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 the API key",
"close_after_duration": 8
}
}'
# Respond to the request
curl -X PATCH https://eu.pwpush.com/api/v2/requests/orpw2wkg00vpn0a/respond \
-H "Content-Type: application/json" \
-d '{
"request": {
"response": "The API key is: sk_live_1234567890"
}
}'
Žiadosť štátov
API používa štandardné stavové kódy HTTP:
200 OK
Žiadosť bola úspešná
201 Created
Vytvorený zdroj
400 Bad Request
Neplatné parametre
422 Unprocessable Entity
Chyby validácie alebo neplatné údaje žiadosti
401 Unauthorized
Vyžaduje sa overenie
403 Forbidden
Prístup zamietnutý
404 Not Found
Zdroj nebol nájdený
Obmedzenie rýchlosti sa zavádza s cieľom chrániť API pred zneužitím a zabezpečiť spravodlivé používanie pre všetkých používateľov. Obmedzenia rýchlosti sa uplatňujú na IP adresu a líšia sa v závislosti od typu požiadavky a koncového bodu.
Počet požiadaviek GET na auditový protokol je obmedzený na 15 požiadaviek za minútu na jednu IP adresu, pričom maximálny počet požiadaviek za 10 sekúnd je 5 a na jedného overeného používateľa alebo API token je to 30 požiadaviek za minútu.
Odpovede na limity sadzieb
Keď požiadavka prekročí limit rýchlosti, API vráti 429 Too Many Requests stavový kód s Retry-After hlavičku, v ktorej sa uvádza, kedy môžete požiadavku opakovať.
Osvedčené postupy
- Implementácia exponenciálnej spätnej odchýlky pri prijatí odpovede 429
- Rešpektujte
Retry-Afterhodnota záhlavia - Odpovede do vyrovnávacej pamäte, ak je to vhodné na zníženie počtu volaní API
- Dávkové operácie, ak je to možné, namiesto podávania mnohých jednotlivých žiadostí
- Monitorovanie používania rozhrania API v aplikácii, aby ste sa vyhli prekročeniu limitov
Poznámka: Limity rýchlosti sú navrhnuté tak, aby zabránili zneužitiu a zároveň umožnili legitímne používanie. Ak sa neustále stretávate s obmedzeniami rýchlosti, zvážte optimalizáciu svojej integrácie alebo kontaktujte podporu a prediskutujte svoj prípad použitia.
Posledná aktualizácia: October 17, 2026