Password Pusher API v2
BETAVisaptveroša REST API dokumentācija paroles Pushher integrēšanai jūsu darba plūsmās, lietojumprogrammās un rīkos.
Beta paziņojums: API v2 pašlaik ir beta versijā. Lai gan esam pielikuši visas pūles, lai nodrošinātu stabilitāti, pirms galīgās versijas iznākšanas var notikt izmaiņas. Mēs gaidām jūsu atsauksmes!
Pārskats
Password Pusher API v2 nodrošina RESTful saskarni drošu paroļu sūtījumu un pieprasījumu izveidei, iegūšanai un pārvaldīšanai. Visi API galapunkti atgriež JSON atbildes un izmanto standarta HTTP statusa kodus.
Nesēja žetona autentifikācija
Droša piekļuve API ar autentifikāciju, kas balstīta uz žetonu
Tikai JSON atbildes
Konsistents JSON formāts visos galapunktos
RESTful dizains
Intuitīvi REST galapunkti, kas atbilst labākajai praksei
Pieprasījumi un pieprasījumi
Vienvirziena un divvirzienu pieprasījumu atbalsts
Paroļu ģenerators
Izveidojiet paroles, parolfrāzes un PIN kodus, izmantojot POST pieprasījumu uz /api/v2/generate
API v2 izmanto lādētāja token autentifikāciju. Lai autentificētos, iekļaujiet savu API token komandā Authorization virsraksts:
Authorization: Bearer YOUR_API_TOKEN
API žetona iegūšana
- Piesakieties savā Password Pusher kontā
- Pārejiet uz savu API žetonu lapu
- API token ģenerēšana
- Kopējiet token un izmantojiet to API pieprasījumos
Piezīme: Daži galapunkti (piemēram, push paziņojuma vai pieprasījuma saņemšana vai paroles ģenerēšana) ir pieejami anonīmi. Pieprasījumu izveide, piekļuve revīzijas žurnāliem un kolekciju pārvaldība prasa autentifikāciju. Ja nepieciešams piemērot darba vides politiku, kas paredz pieteikšanos, iekļaujiet „Bearer“ žetonu pieprasījumu ģenerēšanas laikā.
Visiem API galapunktiem ir prefikss:
https://eu.pwpush.com/api/v2
Beta versijas pieejamība
API v2 pašlaik ir beta versijā un ir pieejama vietnē pwpush.com un pašmāju Pro versijas. API tiks pievienots atvērtā koda versijai pēc tās beta versijas iznākšanas.
Pašmājas instancēm izmantojiet savu domēnu. Iepriekš parādītais pamatadresurs atspoguļo pašreizējo hostu, kuram jūs piekļūstat.
GET /api/v2/version
Atgriež pašreizējo API versiju, informāciju par lietojumprogrammu un funkciju hash, kas apraksta, kuras iespējas ir iespējotas šajā gadījumā.
Pieprasījuma piemērs
curl -X GET https://eu.pwpush.com/api/v2/version
Atbildes piemērs
{
"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
}
}
}
}Funkcijas Hash
anonymous_access - Vai ir atļauta anonīma API lietošana
api_token_authentication - Autentifikācijas atbalsts ar nesēja žetonu
password_generator.enabled - Vai ir ieslēgta paroles, paroles frāzes un PIN koda ģenerēšana
password_generator.valodas - Valodas, kurās ir pieejami atbalstītie paroles vārdu saraksti
accounts.enabled - Vai darba vietu saraksts ir pieejams adresē /api/v2/workspaces (vecais ceļš /api/v2/accounts ir aizstājvārds)
iespēja.pushes.enabled - Push izveide un pārvaldība, izmantojot API
pushes.email_auto_dispatch - Vai šis instances var nosūtīt slepenas saites pa e-pastu izveides brīdī. Tikai funkcijas noteikšana — izmantojiet izveides parametru „notify_recipients“, lai atslēgtu automātisko nosūtīšanu, vienlaikus joprojām norādot „notify_emails_to“ autentificētiem saņēmējiem.
pushes.file_attachments.enabled - Failu pielikumi uz nospiež
pushes.file_attachments.requires_authentication - Failu pielikumiem nepieciešama autentifikācija
pieprasījumi.iespējots - Pieprasījumu izveide un pārvaldība, izmantojot API
pieprasījumi.email_auto_dispatch - Vai šis instances var nosūtīt slepenas saites pa e-pastu izveides brīdī. Tikai funkcijas noteikšana — izmantojiet izveides parametru „notify_recipients“, lai atslēgtu automātisko nosūtīšanu, vienlaikus joprojām norādot „notify_emails_to“ autentificētiem saņēmējiem.
requests.file_attachments.enabled - Failu pielikumi pieprasījuma atbildēs
requests.file_attachments.requires_authentication - Failu pielikumiem nepieciešama autentifikācija
POST /api/v2/generate
Izveido vienu vai vairākas paroles, parolfrāzes vai PIN kodus. Autentifikācija nav obligāta. Anonīmiem pieprasījumiem tiek piemērota pamatdarba vides (vai pašhostētas globālās) politika. Nosūtiet „Bearer“ žetonu, lai izmantotu pieteiktās darba vides politiku, tostarp arī pielāgotos domēnos.
Ja ģeneratora konfigurācija ir atspējota saskaņā ar politiku, opciju pārrakstījumi tiek ignorēti un tiek ņemts vērā tikai skaits.
Ja paroles ģenerēšana ir atspējota, API atgriež kļūdu 403 „Aizliegts”.
Pieprasījumu ģenerēšana ir ierobežota līdz 30 pieprasījumiem minūtē uz vienu IP adresi vai autentificētu lietotāju.
Pieprasījuma struktūra (JSON)
Nosūtiet parametrus JSON objekta saknē. Ja lauki nav norādīti, tiek izmantotas spēkā esošās politikas noklusējuma vērtības.
| Parametrs | Tips | Apraksts |
|---|---|---|
workspace_id
neobligāts
|
string | Autentificēta darba vide, no kuras piemērot politiku. Pieņem arī `account_id`. Atgriež kodu 401, ja izsaucējs nav šīs darba vides loceklis. |
type
neobligāts
|
string | parole, paroles frāze vai PIN kods |
count
neobligāts
|
integer (1-10) | Ģenerējamo vērtību skaits |
language
neobligāts
|
string | Paroles frāžu saraksts: en, es, fr, de vai it |
word_count
neobligāts
|
integer (3-10) | Paroles frāzes vārdu skaits |
separator
neobligāts
|
string | Stings, kas ievietots starp paroles vārdiem |
capitalize
neobligāts
|
boolean | Katru paroles vārdu rakstiet ar lielo burtu |
number
neobligāts
|
boolean | Pievienot ciparus parolfrāzei |
symbol
neobligāts
|
boolean | Pievienot simbolu parolē |
length
neobligāts
|
integer | Paroles garums (4–128) vai PIN koda garums (4–12) |
uppercase
neobligāts
|
boolean | Parolēs iekļaujiet lielos burtus |
lowercase
neobligāts
|
boolean | Parolēs iekļaujiet mazos burtus |
digits
neobligāts
|
boolean | Parolēs iekļaujiet ciparus |
symbols
neobligāts
|
boolean | Parolēs iekļaujiet simbolus |
avoid_ambiguous
neobligāts
|
boolean | Izslēdziet neskaidrus simbolus, piemēram, 0, O, l un 1 |
min_digits
neobligāts
|
integer | Minimālais ciparu skaits parolē |
min_symbols
neobligāts
|
integer | Minimālais simbolu skaits parolē |
charset
neobligāts
|
string | Burtu iestatījums: ASCII, latīņu, kirilica vai grieķu. Jebkura cita vērtība tiek uzskatīta par pielāgotu rakstzīmju kopu. |
Atbildes lauki
| Laukums | Apraksts |
|---|---|
type |
parole, paroles frāze vai PIN kods |
language |
Paroli. Vārdu saraksts, kas izmantots rezultāta ģenerēšanai. |
entropy_bits |
Atbildē norādītā aptuvenā stiprība. Skatīt entropija kā paroles drošības rādītājs. |
results |
Ģenerēto virkņu masīvs |
Pieprasījuma piemērs
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
}'Atbildes piemērs
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Paroles piemērs
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
}'Piemērs: Push izveide un atgūšana
# 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/fkwjfvhall92Piemērs: Izveidot pieprasījumu un atbildēt
# 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"
}
}'Pieprasījums valstis
API izmanto standarta HTTP statusa kodus:
200 OK
Pieprasījums ir veiksmīgs
201 Created
Izveidots resurss
400 Bad Request
Nederīgi parametri
422 Unprocessable Entity
Apstiprināšanas kļūdas vai nederīgi pieprasījuma dati
401 Unauthorized
Nepieciešamā autentifikācija
403 Forbidden
Piekļuve liegta
404 Not Found
Resurss nav atrasts
Lai aizsargātu API no ļaunprātīgas izmantošanas un nodrošinātu godīgu izmantošanu visiem lietotājiem, ir ieviests ātruma ierobežojums. Ātruma ierobežojumi tiek piemēroti katrai IP adresei un atšķiras atkarībā no pieprasījuma veida un galapunkta.
Audita žurnāla GET pieprasījumu skaits ir ierobežots līdz 15 pieprasījumiem minūtē uz vienu IP adresi, ar maksimālo pieprasījumu skaitu 5 pieprasījumi 10 sekundēs, kā arī 30 pieprasījumi minūtē uz vienu autentificētu lietotāju vai API tokenu.
Likmes ierobežojuma atbildes
Ja pieprasījums pārsniedz ātruma ierobežojumu, API atgriež 429 Too Many Requests statusa kods ar Retry-After galveni, kurā norādīts, kad var atkārtot pieprasījumu.
Labākā pieredze
- Eksponenciālā backoff īstenošana, kad saņemat 429 atbildi
- Respektēt
Retry-Aftergalvenes vērtība - Atbildes kešatmiņā, ja nepieciešams, lai samazinātu API izsaukumu skaitu
- Ja iespējams, veiciet sērijveida operācijas, nevis daudzus atsevišķus pieprasījumus
- Uzraudzīt lietojumprogrammas API lietojumu, lai izvairītos no ierobežojumu pārsniegšanas
Piezīme: Tarifu ierobežojumi ir izstrādāti, lai novērstu ļaunprātīgu izmantošanu, vienlaikus ļaujot izmantot likumīgi. Ja pastāvīgi saskaraties ar ātruma ierobežojumiem, apsveriet iespēju optimizēt integrāciju vai sazinieties ar atbalsta dienestu, lai apspriestu savu lietošanas gadījumu.
Pēdējo reizi atjaunināts: October 15, 2026