Password Pusher API 2. bertsioa
BETAREST API dokumentazio osoa Password Pusher zure lan-fluxuetan, aplikazioetan eta tresnetan integratzeko.
Beta oharra: API v2 beta bertsioan dago oraingoz. Egonkortasuna bermatzeko ahalegin guztiak egin ditugun arren, baliteke azken bertsioa baino lehen aldaketa garrantzitsuak egotea. Zure iritzia eskertzen dugu!
Ikuspegi orokorra
Password Pusher API v2-k RESTful interfazea eskaintzen du pasahitz-eskaera seguruak sortzeko, berreskuratzeko eta kudeatzeko. API amaiera-puntu guztiek JSON erantzunak itzultzen dituzte eta HTTP egoera-kode estandarrak erabiltzen dituzte.
Eramailearen Tokenaren Autentifikazioa
API sarbide segurua tokenetan oinarritutako autentifikazioarekin
JSON-bakarrik erantzunak
JSON formatu koherentea amaiera-puntu guztietan
Diseinu RESTful
Praktika onenak jarraituz REST amaiera-puntu intuitiboak
Bultzadak eta eskaerak
Noranzko bakarreko bultzada eta bi norabideko eskaeren laguntza
Pasahitz Sortzailea
Sortu pasahitzak, pasahitz-esaldiak eta PINak POST /api/v2/generate bidez
API v2-k eramaile tokenaren autentifikazioa erabiltzen du. Autentifikatzeko, sartu zure API tokena hemen: Authorization goiburua:
Authorization: Bearer YOUR_API_TOKEN
Zure API tokena lortzea
- Hasi saioa zure Password Pusher kontuan
- Joan zure API tokenen orrialdera
- Sortu API token bat
- Kopiatu tokena eta erabili zure API eskaeretan
Oharra: Amaiera-puntu batzuetara (push edo eskaera bat berreskuratzea edo pasahitza sortzea, adibidez) modu anonimoan sar daiteke. Eskaerak sortzeak, auditoria-erregistroak atzitzeak eta bildumak kudeatzeak autentifikazioa behar du. Sartu eramaile-token bat eskaerak sortzeko saioa hasita duen lan-eremuaren politika behar duzunean.
API amaierako puntu guztiek aurrizki hau dute:
https://eu.pwpush.com/api/v2
Beta erabilgarritasuna
API v2 beta bertsioan dago oraingoz eta eskuragarri dago pwpush.com eta auto-ostatatutako Pro edizioak. APIa kode irekiko edizioari gehituko zaio beta bertsiotik irten ondoren.
Auto-ostatatutako instantzietarako, erabili zure domeinua. Goian agertzen den oinarrizko URLak atzitzen ari zaren uneko ostalaria islatzen du.
GET /api/v2/version
Uneko API bertsioa, aplikazioaren xehetasunak eta instantzia honetan gaituta dauden gaitasunak deskribatzen dituen ezaugarrien hash bat itzultzen ditu.
Eskaera adibidea
curl -X GET https://eu.pwpush.com/api/v2/version
Adibide Erantzuna
{
"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
}
}
}
}Ezaugarrien Hash-a
sarbide_anonimoa - API anonimoaren erabilera baimenduta dagoen ala ez
api_token_authentikazioa - Eramailearen tokenaren autentifikazio-laguntza
pasahitz_sortzailea.gaituta - Pasahitza, pasahitz-esaldia eta PINa sortzeko aukera gaituta dagoen ala ez
pasahitz_sortzailea.hizkuntzak - Onartutako pasahitz-hitzen zerrendako hizkuntzak
kontuak.gaituta - Lan-eremuen zerrenda /api/v2/workspaces helbidean eskuragarri dagoen ala ez (/api/v2/accounts bide zaharra alias bat da)
bultzaka.gaituta - Push sorrera eta kudeaketa API bidez
pushs.email_auto_dispatch - Instantzia honek sortzean esteka sekretuak posta elektronikoz bidali ditzakeen ala ez. Ezaugarrien detekzioa soilik — erabili notify_recipients create parametroa bidalketa automatikoa ez aukeratzeko, autentifikatutako hartzaileentzat notify_emails_to ematen jarraitzen duzun bitartean.
pushs.file_attachments.enabled - Fitxategien eranskinak push-etan
pushs.file_attachments.requires_authentication - Fitxategien eranskinen autentifikazioa behar da
eskaerak.gaituta - Eskaerak sortzea eta kudeatzea API bidez
eskaerak.email_auto_bidalketa - Instantzia honek sortzean esteka sekretuak posta elektronikoz bidali ditzakeen ala ez. Ezaugarrien detekzioa soilik — erabili notify_recipients create parametroa bidalketa automatikoa ez aukeratzeko, autentifikatutako hartzaileentzat notify_emails_to ematen jarraitzen duzun bitartean.
eskaerak.fitxategi_eranskinak.gaituta - Eskaeren erantzunen fitxategi eranskinak
eskaerak.fitxategi_eranskinak.autentifikazioa_beharrezkoa da - Fitxategien eranskinen autentifikazioa behar da
POST /api/v2/generate
Pasahitz, pasahitz edo PIN bat edo gehiago sortzen ditu. Autentifikazioa aukerakoa da. Eskaera anonimoek lan-eremu nagusiko (edo auto-ostatatutako globala) politika erabiltzen dute. Bidali eramaile token bat saioa hasita duen lan-eremuaren politika erabiltzeko, domeinu pertsonalizatuetan barne.
Sorgailuaren konfigurazioa politika bidez desgaituta dagoenean, aukeren gainidazpenak ez dira kontuan hartzen eta zenbaketa bakarrik errespetatzen da.
Pasahitza sortzea desgaituta badago, APIak 403 Debekatuta itzultzen du.
Sorkuntza IP helbide edo autentifikatutako erabiltzaile bakoitzeko minutuko 30 eskaerara mugatuta dago.
Eskaeraren gorputza (JSON)
Bidali parametroak JSON objektuaren erroan. Ezabatutako eremuek indarrean dauden politika lehenetsietara itzultzen dira.
| Parametroa | Mota | Deskribapena |
|---|---|---|
workspace_id
aukerakoa
|
string | Politika aplikatzeko autentifikatutako lan-eremua. Account_id ere onartzen du. 401 itzultzen du deitzailea lan-eremu horretako kide ez bada. |
type
aukerakoa
|
string | pasahitza, pasahitz edo PIN kodea |
count
aukerakoa
|
integer (1-10) | Sortu beharreko balio kopurua |
language
aukerakoa
|
string | Pasahitz-hitzen zerrenda: en, es, fr, de edo it |
word_count
aukerakoa
|
integer (3-10) | Pasa-esaldi bateko hitz kopurua |
separator
aukerakoa
|
string | Katea txertatu da pasahitz hitzen artean |
capitalize
aukerakoa
|
boolean | Maiuskulaz idatzi pasahitz bakoitza |
number
aukerakoa
|
boolean | Gehitu digituak pasahitz bati |
symbol
aukerakoa
|
boolean | Gehitu sinbolo bat pasahitz bati |
length
aukerakoa
|
integer | Pasahitzaren luzera (4–128) edo PINaren luzera (4–12) |
uppercase
aukerakoa
|
boolean | Sartu maiuskulak pasahitzetan |
lowercase
aukerakoa
|
boolean | Sartu letra minuskulak pasahitzetan |
digits
aukerakoa
|
boolean | Sartu digituak pasahitzetan |
symbols
aukerakoa
|
boolean | Sartu sinboloak pasahitzetan |
avoid_ambiguous
aukerakoa
|
boolean | Baztertu 0, O, l eta 1 bezalako karaktere anbiguoak |
min_digits
aukerakoa
|
integer | Pasahitz batek izan behar dituen gutxieneko digitu kopurua |
min_symbols
aukerakoa
|
integer | Pasahitz bateko gutxieneko sinbolo kopurua |
charset
aukerakoa
|
string | Letra aurrezarpena: ascii, latina, zirilikoa edo grekoa. Beste edozein balio karaktere multzo pertsonalizatu gisa tratatzen da. |
Erantzun Eremuak
| Zelaia | Deskribapena |
|---|---|
type |
pasahitza, pasahitz edo PIN kodea |
language |
Pasahitzetarako aurkeztua. Emaitza sortzeko erabilitako hitz zerrenda. |
entropy_bits |
Erantzunean itzulitako indarraren estimazioa. Ikusi Entropia pasahitzaren indarraren neurri gisa. |
results |
Sortutako kateen matrizea |
Eskaera adibidea
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
}'Adibide Erantzuna
{
"type": "passphrase",
"language": "en",
"entropy_bits": 51.7,
"results": ["Correct-Horse-Battery-Staple42", "River-Garden-Lantern-Anchor17"]
}Pasahitz adibidea
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
}'Adibidea: Push bat sortu eta berreskuratu
# 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/fkwjfvhall92Adibidea: Eskaera bat sortu eta erantzun
# 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"
}
}'Eskatutako estatuak
APIak HTTP egoera-kode estandarrak erabiltzen ditu:
200 OK
Eskaera arrakastatsua izan da
201 Created
Baliabidea sortu da
400 Bad Request
Parametro baliogabeak
422 Unprocessable Entity
Balidazio-erroreak edo eskaera-datu baliogabeak
401 Unauthorized
Autentifikazioa beharrezkoa da
403 Forbidden
Sarbidea ukatuta
404 Not Found
Baliabidea ez da aurkitu
APIa gehiegikeriatik babesteko eta erabiltzaile guztientzat erabilera justua bermatzeko abiadura mugak ezartzen dira. Abiadura mugak IP helbide bakoitzeko aplikatzen dira eta eskaera motaren eta amaiera-puntuaren arabera aldatzen dira.
Auditoria-erregistroko GET eskaerak IP bakoitzeko minutuko 15 eskaerara mugatuta daude, 10 segundoko 5 eskaerako mugarekin, eta autentifikatutako erabiltzaile edo API token bakoitzeko minutuko 30 eskaerarekin.
Tasa Muga Erantzunak
Eskaera batek muga gainditzen duenean, APIak itzultzen du 429 Too Many Requests egoera-kodea batekin Retry-After eskaera berriro noiz saiatu zaitezkeen adierazten duen goiburua.
Praktika Egokiak
- Ezarri atzerapen esponentziala 429 erantzuna jasotzen duzunean
- Errespetatu
Retry-Aftergoiburuaren balioa - Gorde erantzunak cachean, egokia denean, API deiak murrizteko
- Eskaera indibidual asko egin beharrean, ahal den guztietan multzoka egindako eragiketak
- Kontrolatu zure aplikazioaren API erabilera mugak saihesteko
Oharra: Abiadura-mugak gehiegikeria saihesteko diseinatuta daude, erabilera legitimoa ahalbidetuz. Abiadura-mugak etengabe aurkitzen badituzu, kontuan hartu integrazioa optimizatzea edo laguntza-zerbitzuarekin harremanetan jartzea zure erabilera-kasua eztabaidatzeko.
Azken eguneraketa: October 11, 2026